net.sf.gridarta.model.data

Interface NamedObject

All Superinterfaces:

java.lang.Comparable<NamedObject>, java.io.Serializable

All Known Subinterfaces:

AnimationObject, FaceObject

All Known Implementing Classes:

AbstractNamedObject, DefaultAnimationObject, DefaultFaceObject

public interface NamedObject
extends java.lang.Comparable<NamedObject>, java.io.Serializable

An AbstractNamedObject has a name and tree position source and provides an icon for display. AbstractNamedObject is the super class of FaceObject and AnimationObject.

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.String	getDisplayIconName() Returns the face name of the display icon for this AbstractNamedObject.
@NotNull java.lang.String	getName() Get the name of this AbstractNamedObject.
@NotNull java.lang.String	getPath() Get the path of this AbstractNamedObject.
void	setPath(@NotNull java.lang.String path) Set the path of this AbstractNamedObject.
java.lang.String	toString()

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

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

Get the name of this AbstractNamedObject. The name should be of user presentable but 100% machine processable nature, means it must be usable for reverse lookup of this AbstractNamedObject in Maps. For faces, the name should be the face name. For animations, the name should be the animation name. For arch objects, the name should be the arch name (definitely not the title).

Returns:

name of this AbstractNamedObject

getPath

@NotNull
@NotNull java.lang.String 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)

setPath

void setPath(@NotNull
             @NotNull java.lang.String path)

Set the path of this AbstractNamedObject.

Parameters:

path - new path for this AbstractNamedObject

See Also:

getPath()

getDisplayIconName

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

Returns the face name of the display icon for this AbstractNamedObject.

Returns:

the face name

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object