PluginParameter.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.plugin.parameter;

import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public interface PluginParameter<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>, V> {

    void addPluginParameterListener(@NotNull PluginParameterListener listener);

    void removePluginParameterListener(@NotNull PluginParameterListener listener);

    @NotNull
    String getName();

    void setName(@NotNull String name);

    @NotNull
    String getParameterType();

    @NotNull
    String getDescription();

    void setDescription(@NotNull String description);

    @NotNull
    V getValue() throws InvalidValueException;

    @Nullable
    V getValueOrNull();

    @NotNull
    String getStringValue();

    boolean setStringValue(@NotNull String stringValue);

    @NotNull
    <T> T visit(@NotNull PluginParameterVisitor<G, A, R, T> visitor);

}