Gridarta Editor
MapPath.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.model.mapmodel;
21 
22 import java.io.Serializable;
23 import java.util.regex.Pattern;
24 import org.jetbrains.annotations.NotNull;
25 import org.jetbrains.annotations.Nullable;
26 
31 public interface MapPath extends Serializable {
32 
37  @NotNull
38  Pattern SEPARATOR = Pattern.compile("/");
39 
45  @NotNull
46  String getPath();
47 
54  @Nullable
55  String getMapComponent();
56 
62  @NotNull
63  @SuppressWarnings("ClassReferencesSubclass")
65 
66 }
net.sf.gridarta.model.mapmodel.AbsoluteMapPath
A MapPath that is absolute, that is, it starts with a "/".
Definition: AbsoluteMapPath.java:29
net.sf.gridarta.model.mapmodel.MapPath.getMapComponent
String getMapComponent()
Returns the initial path component of a map path.
net.sf.gridarta.model.mapmodel.MapPath
Represents a maps directory local map path.
Definition: MapPath.java:31
net.sf.gridarta.model.mapmodel.RelativeMapPath
Represents a maps directory local map path.
Definition: RelativeMapPath.java:29
net.sf.gridarta.model.mapmodel.MapPath.SEPARATOR
Pattern SEPARATOR
A Pattern to split a map path's string representation into components.
Definition: MapPath.java:38
net.sf.gridarta.model.mapmodel.MapPath.getPath
String getPath()
Returns the map path information.
net.sf.gridarta.model.mapmodel.MapPath.getRelativeMapPathFrom
RelativeMapPath getRelativeMapPathFrom(@NotNull AbsoluteMapPath mapPath)
Returns this map path relative to another map path.