org.gridgain.grid.ggfs

Class GridGgfsPath

java.lang.Object

org.gridgain.grid.ggfs.GridGgfsPath

All Implemented Interfaces:

Externalizable, Serializable, Comparable<GridGgfsPath>

public final class GridGgfsPath
extends Object
implements Comparable<GridGgfsPath>, Externalizable

GGFS path to file in the file system. For example, to get information about a file you would use the following code:

     GridGgfsPath dirPath = new GridGgfsPath("/my/working/dir");
     GridGgfsPath filePath = new GridGgfsPath(dirPath, "file.txt");

     // Get metadata about file.
     GridGgfsFile file = ggfs.info(filePath);
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GridGgfsPath() Constructs default root path.
GridGgfsPath(GridGgfsPath parentPath, String childPath) Resolve a child path against a parent path.
GridGgfsPath(String path) Constructs a path from the URI string.
GridGgfsPath(URI uri) Constructs a path from an URI

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(GridGgfsPath o)
List<String>	components() Split full path on components.
int	depth() Return the number of elements in this path.
boolean	equals(Object o)
int	hashCode()
boolean	isSame(GridGgfsPath path) Checks if paths are identical.
boolean	isSubDirectoryOf(GridGgfsPath path) Checks whether this path is a sub-directory of argument.
String	name() Returns the final component of this path.
GridGgfsPath	parent() Returns the parent of a path or null if at root.
void	readExternal(ObjectInput in)
GridGgfsPath	root() Returns a root for this path.
GridGgfsPath	suffix(String suffix) Adds a suffix to the final name in the path.
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

GridGgfsPath

public GridGgfsPath()

Constructs default root path.

GridGgfsPath

public GridGgfsPath(URI uri)

Constructs a path from an URI

Parameters:

uri - URI to create path from.

GridGgfsPath

public GridGgfsPath(String path)

Constructs a path from the URI string.

Parameters:

path - URI string.

GridGgfsPath

public GridGgfsPath(GridGgfsPath parentPath,
            String childPath)

Resolve a child path against a parent path.

Parameters:

parentPath - Parent path.

childPath - Child path.

Method Detail

name

public String name()

Returns the final component of this path.

Returns:

The final component of this path.

root

public GridGgfsPath root()

Returns a root for this path.

Returns:

Root for this path.

components

public List<String> components()

Split full path on components.

Returns:

Path components.

parent

@Nullable
public GridGgfsPath parent()

Returns the parent of a path or null if at root.

Returns:

The parent of a path or null if at root.

suffix

public GridGgfsPath suffix(String suffix)

Adds a suffix to the final name in the path.

Parameters:

suffix - Suffix.

Returns:

Path with suffix.

depth

public int depth()

Return the number of elements in this path.

Returns:

The number of elements in this path, zero depth means root directory.

isSubDirectoryOf

public boolean isSubDirectoryOf(GridGgfsPath path)

Checks whether this path is a sub-directory of argument.

Parameters:

path - Path to check.

Returns:

True if argument is same or a sub-directory of this object.

isSame

public boolean isSame(GridGgfsPath path)

Checks if paths are identical.

Parameters:

path - Path to check.

Returns:

True if paths are identical.

compareTo

public int compareTo(GridGgfsPath o)

Specified by:

compareTo in interface Comparable<GridGgfsPath>

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object