oracle.ide.model
Class NodeFactory

java.lang.Object
  oracle.ide.model.NodeFactory

public final class NodeFactory

extends java.lang.Object

The NodeFactory class is responsible for creating intances of Node.

The type of Node that gets created depends on the URL that is passed into the findOrCreate(URL) and findOrCreate(Class, URL) methods. The NodeFactory makes use of registered Recognizer instances to determine what Node class corresponds to a particular URL.

Every Node instance created by the NodeFactory is cached. An instance of an already created Node can be retrieved from the cache by calling the find(URL) method.

See Also:

Node, Recognizer

Field Summary

static int	NODE_CACHED Update message sent when a node is cached by a factory.
static int	NODE_UNCACHED Update message sent when a node is uncached by a factory.

Method Summary

static void	attach(Observer observer, java.lang.Class type) Associates the specified observer with the given type.
static Node	clone(Node srcNode, java.net.URL dstNodeURL) Returns a new Node instance whose contents are identical to (and copied from) the specified Node.
static void	detach(Observer observer, java.lang.Class type) Removes the specified observer from the given type list of observers.
static Node	find(java.net.URL url) Find the Node associated with the URL.
static Node	findInFolder(Folder folder, java.net.URL url) Searches the specified Folder for an instance of Node whose URL matches the specified URL.
static Node	findOrCreate(java.lang.Class type, java.net.URL url) Returns the Node associated with the URL.
static Node	findOrCreate(java.net.URL url) Returns the Node associated with the URL.
static Node	findOrCreateUsingDefault(java.net.URL url, java.lang.Class defaultNodeType) Returns the Node associated with the URL.
static java.util.Iterator	getCachedNodes() Returns an Iterator over the Node instances that are currently cached.
static java.util.Iterator	getOpenNodes() Returns an Iterator over the Node instances that are currently opened.
static void	recache(java.net.URL oldURL, java.net.URL newURL, Node node) Removes the oldURL from the cache and puts the newURL in the cache so that it is associated with the given Node.
static void	recache(java.net.URL oldURL, java.net.URL newURL, Node node, boolean notify) Removes the oldURL from the cache and puts the newURL in the cache so that it is associated with the given Node.
static Node	uncache(java.net.URL url) Removes the Node with the specified URL from the NodeFactory's cache.
static Node	uncache(java.net.URL url, boolean notify) Removes the Node with the specified URL from the NodeFactory's cache.

Methods inherited from class java.lang.Object

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

Field Detail

NODE_CACHED

public static final int NODE_CACHED

Update message sent when a node is cached by a factory.

NODE_UNCACHED

public static final int NODE_UNCACHED

Update message sent when a node is uncached by a factory.

Method Detail

findOrCreate

public static Node findOrCreate(java.net.URL url)
                         throws java.lang.IllegalAccessException,
                                java.lang.InstantiationException

Returns the Node associated with the URL. If the Node does not exist, a new Node is created.

Parameters:

url - unique URL identifying the node.

Returns:

an existing node or a newly created one.

Throws:

java.lang.IllegalAccessException - if the Node class or its initializer is not accessible.

java.lang.InstantiationException - if the Node class is an abstract class, an interface, an array class, a primitive type, or void; or if the instantiation fails for some other reason.

findOrCreate

public static Node findOrCreate(java.lang.Class type,
                                java.net.URL url)
                         throws java.lang.IllegalAccessException,
                                java.lang.InstantiationException

Returns the Node associated with the URL. If the Node does not exist, a new Node is created.

Parameters:

type - The Class of the node type to create.

url - URL identifying the node's persistent location.

Returns:

an existing Node or a newly created one.

Throws:

java.lang.IllegalAccessException - if the Class or its initializer is not accessible.

java.lang.InstantiationException - if the Class is an abstract class, an interface, an array class, a primitive type, or void; or if the instantiation fails for some other reason.

findOrCreateUsingDefault

public static Node findOrCreateUsingDefault(java.net.URL url,
                                            java.lang.Class defaultNodeType)
                                     throws java.lang.IllegalAccessException,
                                            java.lang.InstantiationException

Returns the Node associated with the URL. If the Node does not exist, a new Node is created.

Parameters:

url - unique URL identifying the node.

defaultNodeType - the default Node type to use if none of the recognizers can recognize the URL. Pass null to indicate that there is no default type, and that null should be returned if no recognizer can recognize the URL.

Returns:

an existing node or a newly created one.

Throws:

java.lang.IllegalAccessException - if the Node class or its initializer is not accessible.

java.lang.InstantiationException - if the Node class is an abstract class, an interface, an array class, a primitive type, or void; or if the instantiation fails for some other reason.

find

public static Node find(java.net.URL url)

Find the Node associated with the URL. If the Node does not exist, null is returned.

Parameters:

url - URL identifying the Node.

Returns:

An existing Node, or null if none exists.

findInFolder

public static Node findInFolder(Folder folder,
                                java.net.URL url)

Searches the specified Folder for an instance of Node whose URL matches the specified URL. If no such Node can be found, null is returned.

clone

public static Node clone(Node srcNode,
                         java.net.URL dstNodeURL)

Returns a new Node instance whose contents are identical to (and copied from) the specified Node. The original Node is not modified. The copying is done based on the last saved state of the srcNode. The returned Node is cached and assigned the URL specified by dstNodeURL.

Parameters:

srcNode - The Node that will be cloned.

dstNodeURL - The URL that is to be assigned to the clone after all of its data has been loaded from the original. This is the URL under which the new Node will be cached by the NodeFactory.

Returns:

The new Node that is a clone of the srcNode.

uncache

public static Node uncache(java.net.URL url)

Removes the Node with the specified URL from the NodeFactory's cache.

uncache

public static Node uncache(java.net.URL url,
                           boolean notify)

Removes the Node with the specified URL from the NodeFactory's cache. If notify is true, it notifies observers that the node was uncached.

recache

public static void recache(java.net.URL oldURL,
                           java.net.URL newURL,
                           Node node)

Removes the oldURL from the cache and puts the newURL in the cache so that it is associated with the given Node.

recache

public static void recache(java.net.URL oldURL,
                           java.net.URL newURL,
                           Node node,
                           boolean notify)

Removes the oldURL from the cache and puts the newURL in the cache so that it is associated with the given Node.

getCachedNodes

public static java.util.Iterator getCachedNodes()

Returns an Iterator over the Node instances that are currently cached. There is no guarantee as to what order the Nodes will be iterated over. Each object iterated over can be downcast to Node.

getOpenNodes

public static java.util.Iterator getOpenNodes()

Returns an Iterator over the Node instances that are currently opened. There is no guarantee as to what order the Nodes will be iterated over. Each object iterated over can be downcast to Node.

attach

public static final void attach(Observer observer,
                                java.lang.Class type)

Associates the specified observer with the given type. Every time an instance of type is cached in the node factory, a NODE_CACHED notification is broadcast to the observer. The type should be the class of node and not of the data. The reason for this is that calling Node.getData() may break lazy loading for some nodes.

detach

public static final void detach(Observer observer,
                                java.lang.Class type)

Removes the specified observer from the given type list of observers.