xyz.thepathfinder.android

Class Path

java.lang.Object

xyz.thepathfinder.android.Path

 class Path
extends Object

Class is used to ease the manipulation of paths to models on the Pathfinder server.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PATH Path to the default cluster.
private static Logger	logger
private String	path A string representing the path.
private static String	PATH_SEPARATOR Separator for path names.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Path(String path) Constructs a path to a model.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getChildPath(String name) Returns the child path of this path plus the name provided.
String	getName() Returns the name of the model.
String	getParentPath() Returns the parent's path of this path.
String	getPath() Returns the path of the model.
static boolean	isValidName(String name) Returns if the provided name is a valid name.
static boolean	isValidPath(String path) Returns if the provided path's characters are valid on the Pathfinder server.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private static final Logger logger

PATH_SEPARATOR

private static final String PATH_SEPARATOR

Separator for path names.

See Also:

Constant Field Values

DEFAULT_PATH

public static final String DEFAULT_PATH

Path to the default cluster.

See Also:

Constant Field Values

path

private String path

A string representing the path.

Constructor Detail

Path

protected Path(String path)

Constructs a path to a model. The path may not an empty string. Other requirements are subject to change. If the path is null it is set to the default pa

Parameters:

path - a string representing the path

Throws:

IllegalArgumentException - when the path is invalid.

Method Detail

isValidPath

public static boolean isValidPath(String path)

Returns if the provided path's characters are valid on the Pathfinder server.

Parameters:

path - to check.

Returns:

true if allowed, false otherwise.

isValidName

public static boolean isValidName(String name)

Returns if the provided name is a valid name.

Parameters:

name - to check.

Returns:

true if allowed, false otherwise.

getChildPath

public String getChildPath(String name)

Returns the child path of this path plus the name provided.

Parameters:

name - to add.

Returns:

the child's path.

Throws:

IllegalArgumentException - if the name is invalid, see isValidName(String).

getName

public String getName()

Returns the name of the model. If the path of this model is "/default/cluster1/subcluster1/transport3" the name is "transport3".

Returns:

the name of the model.

getPath

public String getPath()

Returns the path of the model.

Returns:

the path of the model.

getParentPath

public String getParentPath()

Returns the parent's path of this path. If the path of this model is "/default/cluster1/subcluster1/transport3" the name is "/default/cluster1/subcluster1".

Returns:

the path of the parent of this path.

equals

public boolean equals(Object o)

Overrides:

equals in class Object