Multiverse-Core/src/main/java/com/onarandombox/MultiverseCore/event/MVWorldPropertyChangeEvent.java

/******************************************************************************
 * Multiverse 2 Copyright (c) the Multiverse Team 2011.                       *
 * Multiverse 2 is licensed under the BSD License.                            *
 * For more information please check the README.md file included              *
 * with this project.                                                         *
 ******************************************************************************/

package com.onarandombox.MultiverseCore.event;

import com.onarandombox.MultiverseCore.api.MultiverseWorld;
import org.bukkit.command.CommandSender;
import org.bukkit.event.Cancellable;
import org.bukkit.event.Event;

/**
 * This event is fired *before* the property is actually changed.
 * <p>
 * If it is cancelled, no change will happen.
 * <p>
 * If you want to get the values of the world before the change, query the world.
 * If you want to get the value being changed, use getProperty()
 */
public class MVWorldPropertyChangeEvent extends Event implements Cancellable {
    private MultiverseWorld world;
    private CommandSender changer;
    private boolean isCancelled = false;
    private String value;
    private String name;


    public MVWorldPropertyChangeEvent(MultiverseWorld world, CommandSender changer, String name, String value) {
        super("MVWorldPropertyChange");
        this.world = world;
        this.changer = changer;
        this.name = name;
        this.value = value;
    }

    /**
     * Gets the changed world property's name.
     * @return The changed world property's name.
     */
    public String getPropertyName() {
        return this.name;
    }

    /**
     * Gets the new value.
     * @return The new value.
     */
    public String getNewValue() {
        return this.value;
    }

    /**
     * Sets the new value.
     * @param value The new new value.
     */
    public void setNewValue(String value) {
        this.value = value;
    }

    /**
     * Get the world targeted because of this change.
     *
     * @return A valid MultiverseWorld.
     */
    public MultiverseWorld getWorld() {
        return this.world;
    }

    /**
     * Gets the person (or console) who was responsible for the change.
     *
     * @return The person (or console) who was responsible for the change.
     */
    public CommandSender getCommandSender() {
        return this.changer;
    }

    @Override
    public boolean isCancelled() {
        return this.isCancelled;
    }

    @Override
    public void setCancelled(boolean cancelled) {
        this.isCancelled = cancelled;
    }
}