Gridarta Editor
net.sf.gridarta.model.mapmodel.MapPath Interface Reference

Represents a maps directory local map path. More...

+ Inheritance diagram for net.sf.gridarta.model.mapmodel.MapPath:
+ Collaboration diagram for net.sf.gridarta.model.mapmodel.MapPath:

Public Member Functions

String getMapComponent ()
 Returns the initial path component of a map path. More...
 
String getPath ()
 Returns the map path information. More...
 

Public Attributes

Pattern SEPARATOR = Pattern.compile("/")
 A Pattern to split a map path's string representation into components. More...
 

Detailed Description

Represents a maps directory local map path.

Author
Andreas Kirschbaum

Definition at line 31 of file MapPath.java.

Member Function Documentation

◆ getMapComponent()

String net.sf.gridarta.model.mapmodel.MapPath.getMapComponent ( )

Returns the initial path component of a map path.

"/path/to/map" returns "path", "/map" returns

null

. Relative map paths always return

null

.

Returns
the initial path component

Implemented in net.sf.gridarta.model.mapmodel.RelativeMapPath, and net.sf.gridarta.model.mapmodel.AbsoluteMapPath.

Referenced by net.sf.gridarta.model.mapmodel.MapPathTest.testGetMapComponent1(), and net.sf.gridarta.model.exitconnector.ExitLocation.updateExitObject().

+ Here is the caller graph for this function:

◆ getPath()

String net.sf.gridarta.model.mapmodel.MapPath.getPath ( )

Returns the map path information.

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

Implemented in net.sf.gridarta.model.mapmodel.RelativeMapPath, and net.sf.gridarta.model.mapmodel.AbsoluteMapPath.

Member Data Documentation

◆ SEPARATOR

Pattern net.sf.gridarta.model.mapmodel.MapPath.SEPARATOR = Pattern.compile("/")

A Pattern to split a map path's string representation into components.

Definition at line 38 of file MapPath.java.

Referenced by net.sf.gridarta.model.mapmodel.MapPathUtils.append(), and net.sf.gridarta.model.mapmodel.RelativeMapPath.RelativeMapPath().


The documentation for this interface was generated from the following file: