org.pietschy.command

Class 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(String parentId, String faceName)

Method Summary

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

Constructor Details

FaceId

public FaceId(String parentId,
              String faceName)

Method Details

equals

public boolean equals(Object o)

getName

public String getName()

getParentId

public String getParentId()

hashCode

public int hashCode()

isAnonymous

public boolean isAnonymous()

parseFaceReference

public static FaceId parseFaceReference(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.

parseFaceReference

public static FaceId parseFaceReference(FaceId relative,
                                        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

toString

public 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())
 
Returns:
a string representation of the object.