net.sf.gridarta.model.data

Interface NamedObjects<E extends NamedObject>

All Superinterfaces:

java.lang.Iterable<E>, java.io.Serializable

All Known Subinterfaces:

AnimationObjects, FaceObjects

All Known Implementing Classes:

AbstractAnimationObjects, AbstractFaceObjects, AbstractNamedObjects, DefaultAnimationObjects, DefaultFaceObjects

public interface NamedObjects<E extends NamedObject>
extends java.lang.Iterable<E>, java.io.Serializable

This class manages NamedObjects, managing their tree as well as providing a method for showing a dialog for browsing their tree and selecting one from it. NamedObjects are iterated in Unicode (=ASCII) order.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(@NotNull java.lang.String name) Check whether an object is defined.
E	get(@NotNull java.lang.String objectName) Gets a AbstractNamedObject.
@NotNull java.lang.String	getName() Returns the tree name.
@NotNull NamedTreeNode<E>	getTreeRoot() Get the object tree root.
java.util.Iterator<E>	iterator() NamedObjects are iterated in Unicode (=case sensitive ASCII) order.
int	size() Get the number of objects.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getTreeRoot

@NotNull
@NotNull NamedTreeNode<E> getTreeRoot()

Get the object tree root.

Returns:

object tree root

getName

@NotNull
@NotNull java.lang.String getName()

Returns the tree name.

Returns:

the tree name

size

int size()

Get the number of objects.

Returns:

object count

get

@Nullable
E get(@NotNull
                @NotNull java.lang.String objectName)

Gets a AbstractNamedObject.

Parameters:

objectName - name of object

Returns:

named object for name objectName or null if none found

containsKey

boolean containsKey(@NotNull
                    @NotNull java.lang.String name)

Check whether an object is defined.

Parameters:

name - object name to look for

Returns:

true if an object with that name is defined, otherwise false

iterator

java.util.Iterator<E> iterator()

NamedObjects are iterated in Unicode (=case sensitive ASCII) order.

Specified by:

iterator in interface java.lang.Iterable<E extends NamedObject>