net.sf.gridarta.model.mapmodel

Class AbsoluteMapPath

java.lang.Object

net.sf.gridarta.model.mapmodel.AbsoluteMapPath

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AbsoluteMapPath>, MapPath

public class AbsoluteMapPath
extends java.lang.Object
implements java.lang.Comparable<AbsoluteMapPath>, MapPath

A MapPath that is absolute, that is, it starts with a "/".

See Also:

Serialized Form

Field Summary

Fields inherited from interface net.sf.gridarta.model.mapmodel.MapPath

SEPARATOR

Constructor Summary

Constructors

Constructor and Description
AbsoluteMapPath() Creates a new instance.
AbsoluteMapPath(AbsoluteMapPath parent, java.lang.String name) Creates a new map path based on a parent map path.

Method Summary

Modifier and Type	Method and Description
int	compareTo(AbsoluteMapPath o)
boolean	equals(java.lang.Object obj)
java.lang.String	getMapComponent() Returns the initial path component of a map path.
java.lang.String	getPath() Returns the map path information.
RelativeMapPath	getRelativeMapPathTo(MapPath mapPath) Returns a map path of an another map path relative to this map path.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbsoluteMapPath

public AbsoluteMapPath()

Creates a new instance.

AbsoluteMapPath

public AbsoluteMapPath(@NotNull
                       AbsoluteMapPath parent,
                       @NotNull
                       java.lang.String name)

Creates a new map path based on a parent map path.

Parameters:

parent - the parent map path

name - the name of the child; "." or ".." are allowed

Method Detail

getPath

@NotNull
public java.lang.String getPath()

Returns the map path information.

Specified by:

getPath in interface MapPath

Returns:

the map path information; it does not include a leading "/" for absolute paths

getRelativeMapPathTo

@NotNull
public RelativeMapPath getRelativeMapPathTo(@NotNull
                                                     MapPath mapPath)

Returns a map path of an another map path relative to this map path.

Parameters:

mapPath - the other map path

Returns:

the relative map path from this map path to the other map path

getMapComponent

@Nullable
public java.lang.String getMapComponent()

Returns the initial path component of a map path. "/path/to/map" returns "path", "/map" returns null. Relative map paths always return null.

Specified by:

getMapComponent in interface MapPath

Returns:

the initial path component

compareTo

public int compareTo(@NotNull
                     AbsoluteMapPath o)

Specified by:

compareTo in interface java.lang.Comparable<AbsoluteMapPath>

equals

public boolean equals(@Nullable
                      java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object