Package com.googlecode.objectify.impl

Class Path

java.lang.Object

com.googlecode.objectify.impl.Path

public class Path
extends Object

Path represents the individual steps from the root object to the current property.

Author:

Jeff Schnitzer

Method Summary

Modifier and Type	Method	Description
int	depth()	ROOT is 0, top level Entity properties are 1, embedded things are higher.
boolean	equals(Object obj)	Compares on complete path
Path	extend(String name)
Path	getPrevious()	Get the previous path; for root this will be null
String	getSegment()	Get this segment of the path.
int	hashCode()	Generates hash code for complete path
boolean	isRoot()
static Path	root()
Object	throwIllegalState(String message)	Convenient way to include path location in the exception message.
Object	throwIllegalState(String message, Throwable cause)	Convenient way to include path location in the exception message.
Object	throwNullPointer(String message)	Convenient way to include path location in the exception message.
String	toPathString()	Create the full x.y.z string
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

root

public static Path root()

toPathString

public String toPathString()

Create the full x.y.z string

extend

public Path extend(String name)

getSegment

public String getSegment()

Get this segment of the path. For root this will be null.

getPrevious

public Path getPrevious()

Get the previous path; for root this will be null

isRoot

public boolean isRoot()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Compares on complete path

Overrides:

equals in class Object

hashCode

public int hashCode()

Generates hash code for complete path

Overrides:

hashCode in class Object

throwIllegalState

public Object throwIllegalState(String message)

Convenient way to include path location in the exception message. Never returns.

throwIllegalState

public Object throwIllegalState(String message,
                                Throwable cause)

Convenient way to include path location in the exception message. Never returns.

throwNullPointer

public Object throwNullPointer(String message)

Convenient way to include path location in the exception message. Never returns.

depth

public int depth()

ROOT is 0, top level Entity properties are 1, embedded things are higher.