Gridarta Editor
net.sf.gridarta.model.data.AbstractNamedObject Class Referenceabstract

An. More...

+ Inheritance diagram for net.sf.gridarta.model.data.AbstractNamedObject:
+ Collaboration diagram for net.sf.gridarta.model.data.AbstractNamedObject:

Public Member Functions

int compareTo (@NotNull final NamedObject o)
 
boolean equals (@Nullable final Object obj)
 
String getPath ()
 Get the path of this AbstractNamedObject. More...
 
int hashCode ()
 
void setPath (@NotNull final String path)
 Set the path of this AbstractNamedObject. More...
 
String toString ()
 
- Public Member Functions inherited from net.sf.gridarta.model.data.NamedObject
String getDisplayIconName ()
 Returns the face name of the display icon for this AbstractNamedObject. More...
 
String getName ()
 Get the name of this AbstractNamedObject. More...
 

Protected Member Functions

 AbstractNamedObject (@NotNull final String path)
 Create a AbstractNamedObject. More...
 

Private Attributes

String path
 The path of this object. More...
 

Static Private Attributes

static final long serialVersionUID = 1L
 Serial version UID. More...
 

Detailed Description

An.

has a name and tree position source and provides an icon for display.

is the super class of net.sf.gridarta.model.face.FaceObject and net.sf.gridarta.model.anim.AnimationObject.

Author
Christian Hujer

Definition at line 32 of file AbstractNamedObject.java.

Constructor & Destructor Documentation

◆ AbstractNamedObject()

net.sf.gridarta.model.data.AbstractNamedObject.AbstractNamedObject ( @NotNull final String  path)
protected

Create a AbstractNamedObject.

Parameters
pathPath
See also
getPath()
#setPath(String)

Definition at line 52 of file AbstractNamedObject.java.

References net.sf.gridarta.model.data.AbstractNamedObject.path.

Member Function Documentation

◆ compareTo()

int net.sf.gridarta.model.data.AbstractNamedObject.compareTo ( @NotNull final NamedObject  o)

Definition at line 68 of file AbstractNamedObject.java.

References net.sf.gridarta.model.data.NamedObject.getName().

+ Here is the call graph for this function:

◆ equals()

boolean net.sf.gridarta.model.data.AbstractNamedObject.equals ( @Nullable final Object  obj)

Definition at line 78 of file AbstractNamedObject.java.

References net.sf.gridarta.model.data.NamedObject.getName().

+ Here is the call graph for this function:

◆ getPath()

String net.sf.gridarta.model.data.AbstractNamedObject.getPath ( )

Get the path of this AbstractNamedObject.

The path should be of user presentable but 100% machine processable nature. The path must be usable for creating a tree for this AbstractNamedObject. The path returned by this method does not include the name of the object. The path separator must be "/" independently of the underlying operating system.

Returns
path of this AbstractNamedObject
See also
#setPath(String)

Implements net.sf.gridarta.model.data.NamedObject.

Definition at line 58 of file AbstractNamedObject.java.

References net.sf.gridarta.model.data.AbstractNamedObject.path.

◆ hashCode()

int net.sf.gridarta.model.data.AbstractNamedObject.hashCode ( )

Definition at line 73 of file AbstractNamedObject.java.

References net.sf.gridarta.model.data.NamedObject.getName().

+ Here is the call graph for this function:

◆ setPath()

void net.sf.gridarta.model.data.AbstractNamedObject.setPath ( @NotNull final String  path)

Set the path of this AbstractNamedObject.

Parameters
pathnew path for this AbstractNamedObject
See also
getPath()

Implements net.sf.gridarta.model.data.NamedObject.

Definition at line 63 of file AbstractNamedObject.java.

References net.sf.gridarta.model.data.AbstractNamedObject.path.

◆ toString()

String net.sf.gridarta.model.data.AbstractNamedObject.toString ( )

Member Data Documentation

◆ path

◆ serialVersionUID

final long net.sf.gridarta.model.data.AbstractNamedObject.serialVersionUID = 1L
staticprivate

Serial version UID.

Definition at line 37 of file AbstractNamedObject.java.


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