org.openide.nodes

Class Children.Array

java.lang.Object

org.openide.nodes.Children

org.openide.nodes.Children.Array

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

Children.Keys, Children.SortedArray, Index.ArrayChildren

Enclosing class:

Children

public static class Children.Array
extends Children
implements Cloneable

Implements the storage of node children by an array. Each new child is added at the end of the array. The nodes are returned in the order they were inserted.

Directly subclassing this class is discouraged. Children.Keys is preferable.

Nested Class Summary

Nested classes/interfaces inherited from class org.openide.nodes.Children

Children.Array, Children.Keys<T>, Children.Map<T>, Children.SortedArray, Children.SortedMap<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection<Node>	nodes vector of added children

Fields inherited from class org.openide.nodes.Children

LEAF, MUTEX

Constructor Summary

Constructors

Modifier	Constructor and Description
	Array() Constructs a new array children without any assigned collection.
protected	Array(Collection<Node> c) Constructs a new list and allows a subclass to provide its own implementation of Collection to store data in.

Method Summary

Modifier and Type	Method and Description
boolean	add(Node[] arr) Add nodes to this container but do not call this method.
Object	clone() Clones all nodes that are contained in the children list.
protected Collection<Node>	initCollection() Allow subclasses to create a collection, the first time the children are used.
protected void	refresh() This method can be called by subclasses that directly modify the nodes collection to update the state of the nodes appropriatelly.
boolean	remove(Node[] arr) Remove nodes from the list.

Methods inherited from class org.openide.nodes.Children

addNotify, create, createLazy, findChild, getNode, getNodeAt, getNodes, getNodes, getNodesCount, getNodesCount, isInitialized, nodes, removeNotify, snapshot

Methods inherited from class java.lang.Object

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

Field Detail

nodes

protected Collection<Node> nodes

vector of added children

Constructor Detail

Array

protected Array(Collection<Node> c)

Constructs a new list and allows a subclass to provide its own implementation of Collection to store data in. The collection should be empty and should not be directly accessed in any way after creation.

Parameters:

c - collection to store data in

Array

public Array()

Constructs a new array children without any assigned collection. The collection will be created by a call to method initCollection the first time, children will be used.

Method Detail

clone

public Object clone()

Clones all nodes that are contained in the children list.

Overrides:

clone in class Children

Returns:

the cloned array for this children

initCollection

protected Collection<Node> initCollection()

Allow subclasses to create a collection, the first time the children are used. It is called only if the collection has not been passed in the constructor.

The current implementation returns ArrayList.

Returns:

empty or initialized collection to use

refresh

protected final void refresh()

This method can be called by subclasses that directly modify the nodes collection to update the state of the nodes appropriatelly.

add

public boolean add(Node[] arr)

Description copied from class: Children

Add nodes to this container but do not call this method. If you think you need to do this probably you really wanted to use Children.Keys.setKeys(java.util.Collection<? extends T>) instead. The parent node of these nodes is changed to the parent node of this list. Each node can be added only once. If there is some reason a node cannot be added, for example if the node expects only a special type of subnodes, the method should do nothing and return false to signal that the addition has not been successful.

This method should be implemented by subclasses to filter some nodes, etc.

Specified by:

add in class Children

Parameters:

arr - set of nodes to add to the list

Returns:

true if successfully added

remove

public boolean remove(Node[] arr)

Description copied from class: Children

Remove nodes from the list. Only nodes that are present are removed.

Specified by:

remove in class Children

Parameters:

arr - nodes to be removed

Returns:

true if the nodes could be removed