oracle.ide.model
Class ProjectContent

java.lang.Object
  oracle.javatools.data.HashStructureAdapter
      oracle.ide.model.ProjectContent

public final class ProjectContent
extends HashStructureAdapter

Field Summary

static java.lang.String

CONTENT_SETS_PROPERTY

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Method Summary

boolean	add(Node[] nodes, java.lang.String contentSetKey) Adds the nodes to the project content, specifically adding it to the content set identified by the content set key.
boolean	add(Node node, java.lang.String contentSetKey) Adds the node to the project content, specifically adding it to the content set identified by the content set key.
java.util.Iterator	findChildren(java.lang.Class childType) Retrieves the children of a specific type.
java.util.Iterator	findChildren(java.lang.Class[] types) Retrieves the children that are one of the specified types.
java.util.Iterator	findChildren(java.lang.Class childType, java.lang.String contentSetKey) Retrieves the child Nodes of a specific type by using the provided content set.
ContentSet	getAllContents()
ContentSet	getContentSet(java.lang.String contentSetKey) Returns a ContentSet adapter that wraps the HashStructure located at the specified key within the project.
ListStructure	getContentSetList()
static ContentSetProvider[]	getContentSetProviders()
static ProjectContent	getInstance(HashStructure hash)
static ProjectContent	getInstance(PropertyStorage project)
URLPath	getJavaRootDirs()
java.util.List	getMissingContentSetKeys() If any content set is missing from the project based on the registere ContentSetProviders, this method returns a List of the missing content set keys.
java.util.Iterator	getNodeIterator()
static void	initializeContentSets(Project project)
boolean	isMissingContentSetKeys() Returns whether there are any missing content set keys.
static void	registerContentSetProvider(ContentSetProvider provider) Registers the specified ContentSetProvider.
static void	unregisterContentSetProvider(ContentSetProvider provider) Unregisters the specified ContentSetProvider.

Methods inherited from class oracle.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTENT_SETS_PROPERTY

public static final java.lang.String CONTENT_SETS_PROPERTY

See Also:

Constant Field Values

Method Detail

getMissingContentSetKeys

public java.util.List getMissingContentSetKeys()

If any content set is missing from the project based on the registere ContentSetProviders, this method returns a List of the missing content set keys. If no content sets are missing, this returns an empty List.

Returns:

the List of content set keys

isMissingContentSetKeys

public boolean isMissingContentSetKeys()

Returns whether there are any missing content set keys.

Returns:

true if there're missing keys, false otherwise

initializeContentSets

public static void initializeContentSets(Project project)

getInstance

public static ProjectContent getInstance(PropertyStorage project)

getInstance

public static ProjectContent getInstance(HashStructure hash)

registerContentSetProvider

public static final void registerContentSetProvider(ContentSetProvider provider)

Registers the specified ContentSetProvider. Once registered, the information from the ContentSetProvider will be unioned with other ContentSetProviders to establish the contents of a project.

unregisterContentSetProvider

public static final void unregisterContentSetProvider(ContentSetProvider provider)

Unregisters the specified ContentSetProvider. The object specified must be the exact same instance that was registered through registerContentSetProvider(ContentSetProvider).

getContentSetProviders

public static final ContentSetProvider[] getContentSetProviders()

getContentSet

public ContentSet getContentSet(java.lang.String contentSetKey)

Returns a ContentSet adapter that wraps the HashStructure located at the specified key within the project.

getContentSetList

public final ListStructure getContentSetList()

getAllContents

public final ContentSet getAllContents()

getJavaRootDirs

public final URLPath getJavaRootDirs()

getNodeIterator

public java.util.Iterator getNodeIterator()

findChildren

public final java.util.Iterator findChildren(java.lang.Class childType)

Retrieves the children of a specific type. The full list of children is filtered to only include those children of the specified type.

Parameters:

childType - the Class representing the desired type

Returns:

an Iterator over the filtered child list, guaranteed not to be null.

findChildren

public final java.util.Iterator findChildren(java.lang.Class[] types)

Retrieves the children that are one of the specified types.

Parameters:

types - an array of Class objects indicating the desired types

Returns:

an Iterator over the Project's children that includes only those elements whose type (or supertype) is one of the specified types.

findChildren

public final java.util.Iterator findChildren(java.lang.Class childType,
                                             java.lang.String contentSetKey)

Retrieves the child Nodes of a specific type by using the provided content set.

Parameters:

childType - the Class representing the desired Node type

contentSetKey - a String specifying the key used to register the desired ContentSet

Returns:

an Iterator over the filtered child list, guaranteed not to be null.

See Also:

getContentSet(String), registerContentSetProvider(ContentSetProvider)

add

public boolean add(Node node,
                   java.lang.String contentSetKey)

Adds the node to the project content, specifically adding it to the content set identified by the content set key. The supplied key must match one of the ContentProviders registered with the project. If the key is valid but the node cannot be added to that content set, the node will be added to the Resources content set, if possible.

Parameters:

node - the node to add

contentSetKey - the key that identifies the content set

Returns:

true if the node was added successfully, false if the node could not be added to the specified content set.

See Also:

ContentSetProvider

add

public boolean add(Node[] nodes,
                   java.lang.String contentSetKey)

Adds the nodes to the project content, specifically adding it to the content set identified by the content set key. The supplied key must match one of the ContentProviders registered with the project. If the key is valid but the node cannot be added to that content set, the node will be added to the Resources content set, if possible.

Parameters:

nodes - the nodes to add

contentSetKey - the key that identifies the content set

Returns:

true if all the nodes were added successfully, false if one or more nodes could not be added to the specified content set.

See Also:

ContentSetProvider