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
protected static String	DEFAULT_PATH Default cluster path.
private static org.slf4j.Logger	logger
private ModelType	modelType Type of the model.
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, ModelType modelType) Constructs a path to a model.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
protected Path	getChildPath(String name, ModelType type) Returns the child path of this path plus the name provided.
ModelType	getModelType() Returns the type of the model.
String	getName() Returns the name of the model.
Path	getParentPath() Returns the parent's path of this path.
String	getPathName() Returns the path of the model.
int	hashCode()
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, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private static final org.slf4j.Logger logger

PATH_SEPARATOR

private static final String PATH_SEPARATOR

Separator for path names.

See Also:

Constant Field Values

DEFAULT_PATH

protected static final String DEFAULT_PATH

Default cluster path.

See Also:

Constant Field Values

path

private String path

A string representing the path.

modelType

private ModelType modelType

Type of the model.

Constructor Detail

Path

protected Path(String path,
    ModelType modelType)

Constructs a path to a model. The path may not an empty string. Other requirements are subject to change.

Parameters:

path - a string representing the path.

modelType - type of the model.

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

protected Path getChildPath(String name,
                ModelType type)

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

Parameters:

name - to add.

type - of the model.

Returns:

the child's path.

Throws:

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

IllegalStateException - if the model type isn't a cluster.

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.

getPathName

public String getPathName()

Returns the path of the model.

Returns:

the path of the model.

getParentPath

public Path 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.

getModelType

public ModelType getModelType()

Returns the type of the model.

Returns:

the type of the model.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object