public class DirectoryModelAdapter extends ContainerModelAdapter
ModelAdapter
which adapts the Audit framework to a directory in a
content set. The @link ContentDirectory} object is the root construct
of the model, its contained constructs are the model adapters for the
Node
and ContentDirectory
elements corresponding to the
files and directories in the directory.ModelAdapter
,
ContainerModelAdapter
,
DirectoryModelType
Modifier and Type | Method and Description |
---|---|
protected void |
collectContainedElements()
Collects the contained
Element s of the root construct. |
int |
compareTo(ModelAdapter that)
Gets whether this model is less than, equal to, or greater than another
using the natural order defined by this class.
|
boolean |
contains(ModelAdapter that)
Gets whether this model contains a model.
|
boolean |
contains(java.lang.Object construct,
Location location)
Gets whether a construct in this model contains a location.
|
ContainerModelAdapter |
getContainingAdapter()
Gets the model adapter containing this model adapter, or null if this is
the root node.
|
ContentDirectory |
getDirectory()
Gets the package directory containing this model, or null if none.
|
Location[] |
getElementLocations(Element element)
Gets the locations of the constructs in this model corresponding to an
IDE element.
|
javax.swing.Icon |
getIcon(java.lang.Object construct)
Gets the icon for a construct of this model.
|
java.lang.Object |
getLabel(java.lang.Object construct)
Gets the label for a construct of this model.
|
Node |
getNode()
Gets the IDE
Node corresponding to this model, or null if none
(in particular, if this is the root or a directory model). |
java.lang.Object |
getSummary(java.lang.Object construct)
Gets the summary for a construct of this model.
|
java.lang.String |
toString() |
addContainedElement, addContainedModel, addEmbeddedModel, getConstruct, getContainedConstructs, getContainedUnauditableElements, getLocation, getRootHook, getUrl, isFile
acquireReadLock, acquireReadLock, acquireReadLock, beginRead, beginRead, beginReadHook, cancelRead, compareSiblings, contains, contains, contextDescription, createModelAccessError, createModelAccessError, createModelAccessError, edit, endRead, endRead, endReadHook, enter, equals, exit, getAttribute, getCharacter, getColumnOffset, getConstruct, getDependency, getDirectoryAdapter, getElement, getEndLocation, getFactory, getFileAdapter, getFocusLocation, getFocusLocation, getIcon, getIdeContext, getInitialLength, getLabel, getLine, getLineOffset, getLocation, getLocation, getLock, getNavigationPoint, getPrimaryCollationKey, getProject, getProjectAdapter, getRoot, getSecondaryCollationKey, getSecondaryCollationString, getShortLabel, getSimpleName, getSummary, getText, getType, getUrl, getURL, getWorkspace, getWorkspaceAdapter, hashCode, isAccessible, isModifiable, isModified, isModified, isNavigable, isReadLockHeld, isWriteLockHeld, release, releaseReadLock, releaseReadLock, setAttribute, verifyModelAccess, verifyReadTransaction
public ContainerModelAdapter getContainingAdapter()
ModelAdapter
getContainingAdapter
in class ModelAdapter
public ContentDirectory getDirectory()
ModelAdapter
getDirectory
in class ModelAdapter
public Location[] getElementLocations(Element element)
ModelAdapter
Implementations need only deal with IDE element types that are returned
by the getRootElementTypes
and
getContainedElementTypes
methods
of the model type for this model.
getElementLocations
in class ContainerModelAdapter
element
- an IDE Element
of a type supported by this model.protected void collectContainedElements()
Element
s of the root construct.
Implementations must call ContainerModelAdapter.addContainedElement(oracle.ide.model.Element, java.net.URL)
for each contained
element. This method is invoked by the first invocation of
ContainerModelAdapter.getContainedConstructs(java.lang.Object)
or
#getContainedUnauditableElements, unless {@link #addContainedModel}
has already been invoked.
The Audit framework invokes this method with a read transaction active on this model.
Collects the Node
and ContentDirectory
elements corresponding to the files and directories directly contained by
the adapted directory.
collectContainedElements
in class ContainerModelAdapter
public int compareTo(ModelAdapter that)
ModelAdapter
ModelFactory
instances cannot be compared.compareTo
in interface java.lang.Comparable<ModelAdapter>
compareTo
in class ModelAdapter
that
- The model to which to compare this model.public boolean contains(ModelAdapter that)
ModelAdapter
contains
in class ModelAdapter
that
- The ModelAdapter
to test.public boolean contains(java.lang.Object construct, Location location)
ModelAdapter
The default ModelAdapter
location returns true if the construct is
this
or the location returned for the construct by ModelAdapter.getLocation(Object)
contains the construct
(getLocation(construct).contains(location)
.
Subclasses that can determine containment trivially for some constructs,
or can extract offset and length directly from some constructs and so
avoid the expense of creating a Location
object should override this
method, delegating to super for any constructs they can't optimize. To
determine containment of the location by an offset and length, use
ModelAdapter.contains(int, int, Location)
to ensure correct results for
containment of an empty location.
contains
in class ModelAdapter
construct
- The construct in this node to test.location
- The Location
to test.public java.lang.String toString()
toString
in class ModelAdapter
public Node getNode()
ModelAdapter
Node
corresponding to this model, or null if none
(in particular, if this is the root or a directory model).getNode
in class ModelAdapter
public java.lang.Object getLabel(java.lang.Object construct)
ModelAdapter
Note that the return type is Object
, and Audit waits until
the String is needed to invoke String.valueOf(Object)
to get a
string. Typically, implementations of this method do return a string, but
the return type allows returning an object which defers expensive
formatting to its toString()
method. If necessary, the string
should be localized.
getLabel
in class ModelAdapter
public java.lang.Object getSummary(java.lang.Object construct)
ModelAdapter
Note that the return type is Object
, and Audit waits until
the String is needed to invoke String.valueOf(Object)
to get a
string. Typically, implementations of this method do return a string, but
the return type allows returning an object which defers expensive
formatting to its toString()
method. The string should be
localized.
getSummary
in class ModelAdapter
public javax.swing.Icon getIcon(java.lang.Object construct)
ModelAdapter
getIcon
in class ModelAdapter