Package de.uplanet.lucy.server.usermanager.velocity

Class VelocityDsNodes

java.lang.Object

de.uplanet.lucy.server.usermanager.velocity.VelocityDsNodes

All Implemented Interfaces:

Iterable<AbstractVelocityDsNode>

public final class VelocityDsNodes
extends Object
implements Iterable<AbstractVelocityDsNode>

Method Summary

Modifier and Type	Method	Description
boolean	contains(Object p_obj)	Check if this collection contains an org structure node that matches the given object.
AbstractVelocityDsNode	get(Object p_obj)	Get an org structure node from this collection that matches the given object.
List<String>	getGuids()	Get a list that contains the GUIDs of the nodes in this collection.
VelocityDsNodes	intersect(VelocityDsNodes p_nodes)	Intersect this collection with the given collection.
VelocityDsNodes	intersect(Collection<Object> p_collection)	Intersect this collection with the given collection.
boolean	intersects(VelocityDsNodes p_nodes)	Intersect this collection with the given collection.
boolean	intersects(Collection<Object> p_collection)	Intersect this collection with the given collection.
boolean	isEmpty()	Check if this collection is empty.
Iterator<AbstractVelocityDsNode>	iterator()	Get an read-only iterator over the org structure elements in this collection.
int	size()	Get the number of org structure elements in this collection.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

size

public int size()

Get the number of org structure elements in this collection.

Returns:

The number of org structure elements in this collection.

isEmpty

public boolean isEmpty()

Check if this collection is empty.

Returns:

iterator

public Iterator<AbstractVelocityDsNode> iterator()

Get an read-only iterator over the org structure elements in this collection.

Specified by:

iterator in interface Iterable<AbstractVelocityDsNode>

Returns:

An read-only iterator over the org structure elements in this collection.

contains

public boolean contains(Object p_obj)

Check if this collection contains an org structure node that matches the given object.

Parameters:

p_obj - The key.

Returns:

true if this collection contains an object that matches the given object, or false otherwise.

get

public AbstractVelocityDsNode get(Object p_obj)

Get an org structure node from this collection that matches the given object.

Parameters:

p_obj - The key, either na org structure nodes, a GUID, or a name.

Returns:

The matching org structure node, or null.

intersect

public VelocityDsNodes intersect(Collection<Object> p_collection)

Intersect this collection with the given collection.

Parameters:

p_collection - A collection of org structure nodes, GUIDs, or names.

Returns:

A collection that contains all org structure nodes of this collection that are referenced or contained in the given collection.

Throws:

IllegalArgumentException - If the given collection is null.

intersect

public VelocityDsNodes intersect(VelocityDsNodes p_nodes)

Intersect this collection with the given collection.

Parameters:

p_nodes - A collection VelocityDsNodes.

Returns:

A collection that contains all org structure nodes of this collection that are referenced or contained in the given collection.

Throws:

IllegalArgumentException - If the given collection is null.

intersects

public boolean intersects(Collection<Object> p_collection)

Intersect this collection with the given collection.

Parameters:

p_collection - A collection of org structure nodes, GUIDs, or names.

Returns:

true if the given collection contains an element that is also contained in this collection, or false otherwise.

Throws:

IllegalArgumentException - If the given collection is null.

intersects

public boolean intersects(VelocityDsNodes p_nodes)

Intersect this collection with the given collection.

Parameters:

p_nodes - A collection VelocityDsNodes.

Returns:

true if the given collection contains an element that is also contained in this collection, or false otherwise.

Throws:

IllegalArgumentException - If the given collection is null.

getGuids

public List<String> getGuids()

Get a list that contains the GUIDs of the nodes in this collection. The GUID's order is the same as the node's order.

Returns:

A list of GUIDs.

toString

public String toString()

Overrides:

toString in class Object