org.apache.ignite.igfs

Class IgfsPath

java.lang.Object

org.apache.ignite.igfs.IgfsPath

All Implemented Interfaces:

Externalizable, Serializable, Comparable<IgfsPath>, Binarylizable

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static IgfsPath	ROOT Root path.
static String	SLASH The directory separator.

Constructor Summary

Constructors

Constructor and Description
IgfsPath() Default constructor.
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

Modifier and Type	Method and Description
int	compareTo(IgfsPath o)
List<String>	components() Split full path on components.
String[]	componentsArray() Get components in array form.
int	depth() Return the number of elements in this path.
boolean	equals(Object o)
int	hashCode()
boolean	isSubDirectoryOf(IgfsPath path) Checks whether this path is a sub-directory of argument.
String	name() Returns the final component of this path.
@Nullable IgfsPath	parent() Returns the parent of a path or null if at root.
void	readBinary(BinaryReader reader) Reads fields from provided reader.
void	readExternal(ObjectInput in)
void	readRawBinary(BinaryRawReader reader) Read raw binary.
IgfsPath	suffix(String suffix) Adds a suffix to the final name in the path.
String	toString()
void	writeBinary(BinaryWriter writer) Writes fields to provided writer.
void	writeExternal(ObjectOutput out)
void	writeRawBinary(BinaryRawWriter writer) Write raw binary.

Methods inherited from class java.lang.Object

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

Field Detail

SLASH

public static final String SLASH

The directory separator.

See Also:

Constant Field Values

ROOT

public static final IgfsPath ROOT

Root path.

Constructor Detail

IgfsPath

public IgfsPath()

Default constructor.

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.

components

public List<String> components()

Split full path on components.

Returns:

Path components.

componentsArray

public String[] componentsArray()

Get components in array form.

Returns:

Components array.

parent

@Nullable
public @Nullable 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.

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

writeBinary

public void writeBinary(BinaryWriter writer)
                 throws BinaryObjectException

Writes fields to provided writer.

Specified by:

writeBinary in interface Binarylizable

Parameters:

writer - Binary object writer.

Throws:

BinaryObjectException - In case of error.

readBinary

public void readBinary(BinaryReader reader)
                throws BinaryObjectException

Reads fields from provided reader.

Specified by:

readBinary in interface Binarylizable

Parameters:

reader - Binary object reader.

Throws:

BinaryObjectException - In case of error.

writeRawBinary

public void writeRawBinary(BinaryRawWriter writer)
                    throws BinaryObjectException

Write raw binary.

Parameters:

writer - Raw writer.

Throws:

BinaryObjectException - If failed.

readRawBinary

public void readRawBinary(BinaryRawReader reader)
                   throws BinaryObjectException

Read raw binary.

Parameters:

reader - Raw reader.

Throws:

BinaryObjectException - If failed.

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