xyz.thepathfinder.android.Path Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pathfinder-android Show documentation
Android/Java client library for the Pathfinder service
There is a newer version: 1.0.1
package xyz.thepathfinder.android;

/**
 * Class is used to ease the manipulation of paths to models on the Pathfinder server.
 *
 * @author David Robinson
 */
class Path {

    /**
     * Separator for path names.
     */
    private static final String PATH_SEPARATOR = "/";

    /**
     * Path to the default cluster.
     */
    public static final String DEFAULT_PATH = "/default";

    /**
     * A string representing the path.
     */
    private 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
     *
     * @param path a string representing the path
     * @throws IllegalArgumentException when the path is invalid.
     */
    protected Path(String path) {
        if (!Path.isValidPath(path)) {
            throw new IllegalArgumentException("Path cannot be an empty string");
        }

        if (path == null) {
            this.path = Path.DEFAULT_PATH;
        } else {
            this.path = path;
        }
    }

    /**
     * Returns if the provided path's characters are valid on the Pathfinder server.
     *
     * @param path to check.
     * @return true if allowed, false otherwise.
     */
    public static boolean isValidPath(String path) {
        return !(path != null && path.equals(""));
    }

    /**
     * Returns if the provided name is a valid name.
     *
     * @param name to check.
     * @return true if allowed, false otherwise.
     */
    public static boolean isValidName(String name) {
        return !name.contains(Path.PATH_SEPARATOR);
    }

    /**
     * Returns the child path of this path plus the name provided.
     *
     * @param name to add.
     * @return the child's path.
     * @throws IllegalArgumentException if the name is invalid, see {@link Path#isValidName(String)}.
     */
    public String getChildPath(String name) {
        if (Path.isValidName(name)) {
            return this.path + Path.PATH_SEPARATOR + name;
        } else {
            throw new IllegalArgumentException("Invalid path name: " + name);
        }
    }

    /**
     * Returns the name of the model. If the path of this model is
     * "/default/cluster1/subcluster1/transport3" the name is
     * "transport3".
     *
     * @return the name of the model.
     */
    public String getName() {
        int lastSlashIndex = this.path.lastIndexOf(Path.PATH_SEPARATOR) + 1;
        return this.path.substring(lastSlashIndex);
    }

    /**
     * Returns the path of the model.
     *
     * @return the path of the model.
     */
    public String getPath() {
        return path;
    }

    /**
     * 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".
     *
     * @return the path of the parent of this path.
     */
    public String getParentPath() {
        int lastSlashIndex = this.path.lastIndexOf(Path.PATH_SEPARATOR);
        return this.path.substring(0, lastSlashIndex);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(Object o) {
        if (o instanceof Path) {
            Path otherPath = (Path) o;
            return this.path.equals(otherPath.path);
        }
        return false;
    }
}