org.eclipse.xtext.resource

Interface ISelectable

All Known Subinterfaces:

IContainer, IResourceDescription, IResourceDescriptions, IResourceDescriptions.IContextAware, IResourceDescriptions.IResourceSetAware

All Known Implementing Classes:

AbstractCompoundSelectable, AbstractContainer, AbstractResourceDescription, ChunkedResourceDescriptions, DefaultResourceDescription, DefaultUniqueNameContext.VisibleContainers.Selectable, DescriptionAddingContainer, EagerResourceSetBasedResourceDescriptions, EObjectDescriptionLookUp, FilterUriContainer, Indexer.ResolvedResourceDescription, IResourceDescriptions.NullImpl, LiveShadowedChunkedContainer, LiveShadowedChunkedResourceDescriptions, LiveShadowedResourceDescriptions, LoadOnDemandResourceDescriptions, LocalUniqueNameContext, MultimapBasedSelectable, ResourceDescriptionsBasedContainer, ResourceDescriptionsData, ResourceSetBasedResourceDescriptions, ScopeBasedSelectable, SerializableResourceDescription, StateBasedContainer

public interface ISelectable

An ISelectable is something that can be queried for exported object. Thereby it serves as a common abstract super concept for IContainer and IResourceDescription. Furthermore there is an implementation of the IScope interface that is based on ISelectable and vice versa. All implementations of ISelectable can deal with ignore case and case sensitive queries.

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<IEObjectDescription>	getExportedObjects()
java.lang.Iterable<IEObjectDescription>	getExportedObjects(org.eclipse.emf.ecore.EClass type, QualifiedName name, boolean ignoreCase)
java.lang.Iterable<IEObjectDescription>	getExportedObjectsByObject(org.eclipse.emf.ecore.EObject object)
java.lang.Iterable<IEObjectDescription>	getExportedObjectsByType(org.eclipse.emf.ecore.EClass type)
boolean	isEmpty() Clients may want to check the selectable to skip its processing in case it is empty.

Method Detail

isEmpty

boolean isEmpty()

Clients may want to check the selectable to skip its processing in case it is empty. Implementations should be fast and not require expensive precalculation. Selectable may return false if it is too expensive to compute the actual result.

Returns:

true if the selectable does not provide any descriptions.

getExportedObjects

java.lang.Iterable<IEObjectDescription> getExportedObjects()

Returns:

all exported elements. May not be null.

getExportedObjects

java.lang.Iterable<IEObjectDescription> getExportedObjects(org.eclipse.emf.ecore.EClass type,
                                                           QualifiedName name,
                                                           boolean ignoreCase)

Returns:

all elements which match the given qualified name and type. May not be null.

getExportedObjectsByType

java.lang.Iterable<IEObjectDescription> getExportedObjectsByType(org.eclipse.emf.ecore.EClass type)

Returns:

all elements which match the given type. May not be null.

getExportedObjectsByObject

java.lang.Iterable<IEObjectDescription> getExportedObjectsByObject(org.eclipse.emf.ecore.EObject object)

Returns:

all elements which match the given instance. May not be null.