com.emc.atmos.api

Class ObjectPath

java.lang.Object

com.emc.atmos.api.ObjectPath

All Implemented Interfaces:

ObjectIdentifier

public class ObjectPath
extends java.lang.Object
implements ObjectIdentifier

Represents the full path to an object within a subtenant namespace. Paths always start with a slash. Directories always end with a slash and non-directories never end with a slash.

Constructor Summary

Constructors

Constructor and Description
ObjectPath(ObjectPath parent, DirectoryEntry directoryEntry) Constructs a new path from a parent directory and (what is assumed to be) one of its directory entries.
ObjectPath(ObjectPath parent, java.lang.String path) Constructs a new path underneath a parent directory.
ObjectPath(java.lang.String path)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getFilename() Convenience method to return the filename of this path (the last token delimited by a slash)
java.lang.String	getPath()
java.lang.String	getRelativeResourcePath() Returns the service-relative resource path for this identifier (i.e.
int	hashCode()
boolean	isDirectory() Convenience method to determine whether this path represents a directory in Atmos.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectPath

public ObjectPath(java.lang.String path)

ObjectPath

public ObjectPath(ObjectPath parent,
                  java.lang.String path)

Constructs a new path underneath a parent directory.

Parameters:

parent - The parent directory under which this new path exists (must end with a slash).

path - The relative path to this object under the parent directory (may begin with a slash, but it will be ignored).

ObjectPath

public ObjectPath(ObjectPath parent,
                  DirectoryEntry directoryEntry)

Constructs a new path from a parent directory and (what is assumed to be) one of its directory entries. The resulting path will be a directory or file consistent with the directoryEntry.

Parameters:

parent - The parent directory under which this new path exists (must end with a slash).

directoryEntry - A directory entry of an object (presumed to be under the parent path)

Method Detail

getPath

public java.lang.String getPath()

getRelativeResourcePath

public java.lang.String getRelativeResourcePath()

Description copied from interface: ObjectIdentifier

Returns the service-relative resource path for this identifier (i.e. "objects/{objectId}" for ObjectId).

Specified by:

getRelativeResourcePath in interface ObjectIdentifier

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.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

isDirectory

public boolean isDirectory()

Convenience method to determine whether this path represents a directory in Atmos. Atmos uses a convention where directory paths always end with a slash and object paths do not.

getFilename

public java.lang.String getFilename()

Convenience method to return the filename of this path (the last token delimited by a slash)