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

Field Summary

Fields

Modifier and Type	Field and Description
static String	NULL_INDEXES Unfortunately, we made a mistake in the original definition of the ^null property for embedded collections.

Method Summary

Methods

Modifier and Type	Method and Description
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
static Path	of(String pathString) Convert an x.y.z path string back into a Path
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.
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

Field Detail

NULL_INDEXES

public static final String NULL_INDEXES

Unfortunately, we made a mistake in the original definition of the ^null property for embedded collections. Instead of thing.^null we defined it as thing^null, which requires special casing. So we are fixing this now - we read thing^null as thing.^null, and always save as thing.^null. Some day in the far future we can remove this hack.

See Also:

Constant Field Values

Method Detail

root

public static Path root()

of

public static Path of(String pathString)

Convert an x.y.z path string back into a Path

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

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.