MapFile.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 The Gridarta Developers.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package net.sf.gridarta.model.mapmodel;
 
import java.io.File;
import java.io.Serializable;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class MapFile implements Serializable {
 
    private static final long serialVersionUID = 1L;
 
    @NotNull
    private final File mapsDir;
 
    @NotNull
    private final AbsoluteMapPath mapPath;
 
    public MapFile(@NotNull final File mapsDir) {
        this.mapsDir = mapsDir;
        mapPath = new AbsoluteMapPath();
    }
 
    public MapFile(@NotNull final MapFile parent, @NotNull final String name) {
        mapsDir = parent.mapsDir;
        mapPath = new AbsoluteMapPath(parent.mapPath, name);
    }
 
    public MapFile(@NotNull final MapFile parent, @NotNull final MapPath mapPath) {
        mapsDir = parent.mapsDir;
        this.mapPath = MapPathUtils.append(parent.mapPath, mapPath);
    }
 
    @NotNull
    public File getMapsDir() {
        return mapsDir;
    }
 
    @NotNull
    public AbsoluteMapPath getMapPath() {
        return mapPath;
    }
 
    @NotNull
    public File getFile() {
        return new File(mapsDir, mapPath.getPath());
    }
 
    @NotNull
    public MapPath getRelativeMapFileTo(@NotNull final MapFile mapFile) throws DifferentMapBaseException {
        if (!mapsDir.equals(mapFile.mapsDir)) {
            throw new DifferentMapBaseException(this, mapFile);
        }
        return mapFile.mapPath.getRelativeMapPathFrom(mapPath);
    }
 
    @Override
    public boolean equals(@Nullable final Object obj) {
        if (obj == null || getClass() != obj.getClass()) {
            return false;
        }
        final MapFile mapFile = (MapFile) obj;
        return mapsDir.equals(mapFile.mapsDir) && mapPath.equals(mapFile.mapPath);
    }
 
    @Override
    public int hashCode() {
        return mapsDir.hashCode() + mapPath.hashCode();
    }
 
    @Override
    public String toString() {
        return mapPath.toString();
    }
 
}