net.sf.gridarta.model.mapmodel

Class RelativeMapPath

java.lang.Object

net.sf.gridarta.model.mapmodel.RelativeMapPath

All Implemented Interfaces:

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

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

Represents a maps directory local map path.

See Also:

Serialized Form

Field Summary

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

SEPARATOR

Constructor Summary

Constructors

Constructor and Description
RelativeMapPath() Creates a new instance.
RelativeMapPath(AbsoluteMapPath sourceMapPath, AbsoluteMapPath destinationMapPath) Creates a new instance as the difference between two absolute map paths.
RelativeMapPath(RelativeMapPath 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(RelativeMapPath 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.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RelativeMapPath

public RelativeMapPath()

Creates a new instance.

RelativeMapPath

public RelativeMapPath(@NotNull
                       RelativeMapPath 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

RelativeMapPath

public RelativeMapPath(@NotNull
                       AbsoluteMapPath sourceMapPath,
                       @NotNull
                       AbsoluteMapPath destinationMapPath)

Creates a new instance as the difference between two absolute map paths.

Parameters:

sourceMapPath - the source map path to start from

destinationMapPath - the destination map path to point to

No Inspection:

TypeMayBeWeakened

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

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
                     RelativeMapPath o)

Specified by:

compareTo in interface java.lang.Comparable<RelativeMapPath>

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