org.apache.ignite.igfs

Class IgfsPath

java.lang.Object

org.apache.ignite.igfs.IgfsPath

All Implemented Interfaces:

Externalizable, Serializable, Comparable<IgfsPath>

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

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

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

     // Get metadata about file.
     IgfsFile file = igfs.info(filePath);
 

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(IgfsPath 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(IgfsPath path) Checks if paths are identical.
boolean	isSubDirectoryOf(IgfsPath path) Checks whether this path is a sub-directory of argument.
String	name() Returns the final component of this path.
IgfsPath	parent() Returns the parent of a path or null if at root.
void	readExternal(ObjectInput in)
IgfsPath	root() Returns a root for this path.
IgfsPath	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

IgfsPath

public IgfsPath()

Constructs default root path.

IgfsPath

public IgfsPath(URI uri)

Constructs a path from an URI

Parameters:

uri - URI to create path from.

IgfsPath

public IgfsPath(String path)

Constructs a path from the URI string.

Parameters:

path - URI string.

IgfsPath

public IgfsPath(IgfsPath 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 IgfsPath 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 IgfsPath 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 IgfsPath 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(IgfsPath 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(IgfsPath path)

Checks if paths are identical.

Parameters:

path - Path to check.

Returns:

True if paths are identical.

compareTo

public int compareTo(IgfsPath o)

Specified by:

compareTo in interface Comparable<IgfsPath>

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