Gridarta Editor
net.sf.gridarta.model.anim.AbstractAnimationObjects Class Referenceabstract

Abstract base class for AnimationObjects implementations. More...

+ Inheritance diagram for net.sf.gridarta.model.anim.AbstractAnimationObjects:
+ Collaboration diagram for net.sf.gridarta.model.anim.AbstractAnimationObjects:

Public Member Functions

void addAnimationObject (@NotNull final String animName, @NotNull final String list, @NotNull final String path) throws DuplicateAnimationException, IllegalAnimationException
 Adds a new animation object. More...
 
- Public Member Functions inherited from net.sf.gridarta.model.data.AbstractNamedObjects< E extends NamedObject >
boolean containsKey (@NotNull final String name)
 
get (@NotNull final String objectName)
 
String getName ()
 
NamedTreeNode< E > getTreeRoot ()
 
Iterator< E > iterator ()
 
int size ()
 
- Public Member Functions inherited from net.sf.gridarta.model.data.NamedObjects< E >
boolean containsKey ( @NotNull String name)
 Check whether an object is defined. More...
 
get ( @NotNull String objectName)
 Gets a AbstractNamedObject. More...
 
String getName ()
 Returns the tree name. More...
 
NamedTreeNode< E > getTreeRoot ()
 Get the object tree root. More...
 
Iterator< E > iterator ()
 NamedObjects are iterated in Unicode (=case sensitive ASCII) order. More...
 
int size ()
 Get the number of objects. More...
 
- Public Member Functions inherited from net.sf.gridarta.model.data.NamedObjects< E extends NamedObject >
boolean containsKey (@NotNull String name)
 Check whether an object is defined. More...
 
get (@NotNull String objectName)
 Gets a AbstractNamedObject. More...
 
String getName ()
 Returns the tree name. More...
 
NamedTreeNode< E > getTreeRoot ()
 Get the object tree root. More...
 
Iterator< E > iterator ()
 NamedObjects are iterated in Unicode (=case sensitive ASCII) order. More...
 
int size ()
 Get the number of objects. More...
 

Protected Member Functions

 AbstractAnimationObjects (final String name)
 Creates a new instance. More...
 
- Protected Member Functions inherited from net.sf.gridarta.model.data.AbstractNamedObjects< E extends NamedObject >
 AbstractNamedObjects (final String name)
 Create a NamedObjects instance. More...
 
void put (@NotNull final E object) throws IllegalNamedObjectException
 Store a AbstractNamedObject. More...
 

Static Private Attributes

static final long serialVersionUID = 1L
 The serial version UID. More...
 

Detailed Description

Abstract base class for AnimationObjects implementations.

Author
Christian Hujer
Andreas Kirschbaum

Definition at line 31 of file AbstractAnimationObjects.java.

Constructor & Destructor Documentation

◆ AbstractAnimationObjects()

net.sf.gridarta.model.anim.AbstractAnimationObjects.AbstractAnimationObjects ( final String  name)
protected

Creates a new instance.

Parameters
namethe localized name of the object type, e.g. used in dialogs

Definition at line 42 of file AbstractAnimationObjects.java.

Member Function Documentation

◆ addAnimationObject()

void net.sf.gridarta.model.anim.AbstractAnimationObjects.addAnimationObject ( @NotNull final String  animName,
@NotNull final String  list,
@NotNull final String  path 
) throws DuplicateAnimationException, IllegalAnimationException

Adds a new animation object.

Parameters
animNamename of the animation object to add
listString with animation list data
pathPath relative to the arch directory
Exceptions
DuplicateAnimationExceptionin case the animation was not unique
IllegalAnimationExceptionif the animation cannot be added

Implements net.sf.gridarta.model.anim.AnimationObjects.

Definition at line 55 of file AbstractAnimationObjects.java.

References net.sf.gridarta.model.data.AbstractNamedObjects< E extends NamedObject >.containsKey(), and net.sf.gridarta.model.data.AbstractNamedObjects< E extends NamedObject >.put().

+ Here is the call graph for this function:

Member Data Documentation

◆ serialVersionUID

final long net.sf.gridarta.model.anim.AbstractAnimationObjects.serialVersionUID = 1L
staticprivate

The serial version UID.

Definition at line 36 of file AbstractAnimationObjects.java.


The documentation for this class was generated from the following file: