AbstractArchetype.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2015 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.archetype;

import net.sf.gridarta.model.anim.AnimationObjects;
import net.sf.gridarta.model.baseobject.AbstractBaseObject;
import net.sf.gridarta.model.baseobject.BaseObjectVisitor;
import net.sf.gridarta.model.face.FaceObjectProviders;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.gameobject.GameObjectFactory;
import net.sf.gridarta.model.gameobject.MultiArchData;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapmodel.MapSquare;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public abstract class AbstractArchetype<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractBaseObject<G, A, R, R> implements Archetype<G, A, R> {

    private static final long serialVersionUID = 1L;

    @NotNull
    private String archetypeName;

    private int multiX;

    private int multiY;

    private boolean isLowestPart = true;

    private int multiShapeID;

    private int multiPartNr;

    @Nullable
    private String editorFolder;

    private boolean artifact;

    protected AbstractArchetype(@NotNull final String archetypeName, @NotNull final FaceObjectProviders faceObjectProviders, @NotNull final AnimationObjects animationObjects) {
        super(faceObjectProviders, animationObjects);
        this.archetypeName = archetypeName.intern();
        updateArchetype();
    }

    @Nullable
    @Override
    public MapSquare<G, A, R> getMapSquare() {
        return null; // archetypes are never part of a container
    }

    @Override
    @NotNull
    public String getAttributeString(@NotNull final String attributeName, final boolean queryArchetype) {
        final String result = getAttributeValue(attributeName);
        return result == null ? "" : result;
    }

    @Nullable
    @Override
    protected String getEffectiveFaceName(@NotNull final String faceName) {
        final String normalizedFaceName = faceName.isEmpty() ? null : faceName.intern();
        //Strings are interned
        //noinspection StringEquality
        return normalizedFaceName != null && !normalizedFaceName.isEmpty() ? normalizedFaceName : null;
    }

    @Override
    public void notifyBeginChange() {
        // ignore
    }

    @Override
    public void notifyEndChange() {
        // ignore
    }

    @Override
    public void notifyTransientChange() {
        // ignore
    }

    @NotNull
    @Override
    public R getArchetype() {
        return getThis();
    }

    @NotNull
    @Override
    @SuppressWarnings("unchecked")
    public R clone() {
        //noinspection OverriddenMethodCallDuringObjectConstruction
        final AbstractArchetype<G, A, R> clone = (AbstractArchetype<G, A, R>) super.clone();
        return clone.getThis();
    }

    @Nullable
    @Override
    public G asGameObject() {
        return null;
    }

    @NotNull
    @Override
    public G newInstance(@NotNull final GameObjectFactory<G, A, R> gameObjectFactory) {
        return gameObjectFactory.createGameObject(getThis());
    }

    @Override
    public void visit(@NotNull final BaseObjectVisitor<G, A, R> baseObjectVisitor) {
        baseObjectVisitor.visit(this);
    }

    @NotNull
    @Override
    public String getArchetypeName() {
        return archetypeName;
    }

    @Override
    public void setArchetypeName(@NotNull final String archetypeName) {
        this.archetypeName = archetypeName;
    }

    @Override
    public void setMultiX(final int multiX) {
        this.multiX = multiX;
    }

    @Override
    public void setMultiY(final int multiY) {
        this.multiY = multiY;
    }

    @Override
    public int getMultiX() {
        return multiX;
    }

    @Override
    public int getMultiY() {
        return multiY;
    }

    @Override
    public boolean isLowestPart() {
        return isLowestPart;
    }

    @Override
    public void setLowestPart(final boolean isLowestPart) {
        this.isLowestPart = isLowestPart;
    }

    @Override
    public int getMultiShapeID() {
        return multiShapeID;
    }

    @Override
    public void setMultiShapeID(final int multiShapeID) {
        this.multiShapeID = multiShapeID;
        final MultiArchData<G, A, R, R> multi = getMulti();
        if (multi != null) {
            multi.setMultiShapeID(multiShapeID);
        }
    }

    @Override
    public int getMultiPartNr() {
        return multiPartNr;
    }

    @Override
    public void setMultiPartNr(final int multiPartNr) {
        this.multiPartNr = multiPartNr;
    }

    @Nullable
    @Override
    public String getEditorFolder() {
        return editorFolder;
    }

    @Override
    public void setEditorFolder(@Nullable final String editorFolder) {
        this.editorFolder = editorFolder;
    }

    @Override
    public boolean isArtifact() {
        return artifact;
    }

    @Override
    public void setArtifact() {
        artifact = true;
    }

}