org.pietschy.command
Class FaceId

java.lang.Object
  org.pietschy.command.FaceId

public class FaceId
extends java.lang.Object

A class that represents the Id of a Face. It consists of the id of the face's parent and the name of the face.

Constructor Summary

FaceId(java.lang.String parentId, java.lang.String faceName)

Method Summary

boolean	equals(java.lang.Object o)
java.lang.String	getName()
java.lang.String	getParentId()
int	hashCode()
boolean	isAnonymous()
static FaceId	parseFaceReference(FaceId relative, java.lang.String relativeId) Parses a string of the form '<parentId>[<faceName>]' to generate a new faceid based on the current face.
static FaceId	parseFaceReference(java.lang.String string) Parses a string of the form '<parentId>[<faceName>]'.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FaceId

public FaceId(java.lang.String parentId,
              java.lang.String faceName)

Method Detail

getName

public java.lang.String getName()

getParentId

public java.lang.String getParentId()

isAnonymous

public boolean isAnonymous()

toString

public java.lang.String toString()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

parseFaceReference

public static FaceId parseFaceReference(FaceId relative,
                                        java.lang.String relativeId)

Parses a string of the form '<parentId>[<faceName>]' to generate a new faceid based on the current face. This method can also parse relative references that don't define the parent element.

Parameters:

relative - the face that defines the parent for relative ids.

relativeId - the face id that is to be parsed.

Returns:

a new FaceId

parseFaceReference

public static FaceId parseFaceReference(java.lang.String string)

Parses a string of the form '<parentId>[<faceName>]'.

Parameters:

string - the face id of the form form '<parentId>[<faceName>]'.

Returns:

a face id matching the specified string.

Throws:

java.lang.IllegalArgumentException - if the string doesn't confirm the the specified standard.