Upstream/Multiverse-Core
1
0
Fork 0
mirror of https://github.com/Multiverse/Multiverse-Core.git synced 2024-09-30 08:07:29 +02:00
Code Issues Projects Releases Wiki Activity

Update World API's comments to reflect new API changes

Browse Source
This commit is contained in:
Eric Stokes 2011-09-25 10:43:22 -06:00
parent e5646bbbfd
commit b378b0cf79
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/main/java/com/onarandombox/MultiverseCore/api/MultiverseWorld.java
View File

@ -9,7 +9,11 @@ package com.onarandombox.MultiverseCore.api;
import org.bukkit.World;
/** The API for a Multiverse Handled World. */
/**
* The API for a Multiverse Handled World.
* <p/>
* Currently INCOMPLETE
*/
public interface MultiverseWorld {
/**
@ -20,9 +24,9 @@ public interface MultiverseWorld {
public World getCBWorld();
/**
* Adds the property to the given value. The property must be a {@link com.onarandombox.MultiverseCore.commands.SetProperties}.
* Adds the property to the given value. The property must be a {@link com.onarandombox.MultiverseCore.enums.SetProperties}.
*
* @param property The name of a {@link com.onarandombox.MultiverseCore.commands.SetProperties} to set.
* @param property The name of a {@link com.onarandombox.MultiverseCore.enums.SetProperties} to set.
* @param value A value in string representation, it will be parsed to the correct type.
*
* @return True if the value was set, false if not.
@ -30,18 +34,18 @@ public interface MultiverseWorld {
public boolean setVariable(String property, String value);
/**
* Removes all values from the given property. The property must be a {@link com.onarandombox.MultiverseCore.commands.AddProperties}.
* Removes all values from the given property. The property must be a {@link com.onarandombox.MultiverseCore.enums.AddProperties}.
*
* @param property The name of a {@link com.onarandombox.MultiverseCore.commands.AddProperties} to clear.
* @param property The name of a {@link com.onarandombox.MultiverseCore.enums.AddProperties} to clear.
*
* @return True if it was cleared, false if not.
*/
public boolean clearVariable(String property);
/**
* Adds a value to the given property. The property must be a {@link com.onarandombox.MultiverseCore.commands.AddProperties}.
* Adds a value to the given property. The property must be a {@link com.onarandombox.MultiverseCore.enums.AddProperties}.
*
* @param property The name of a {@link com.onarandombox.MultiverseCore.commands.AddProperties} to add a value to.
* @param property The name of a {@link com.onarandombox.MultiverseCore.enums.AddProperties} to add a value to.
* @param value A value in string representation, it will be parsed to the correct type.
*
* @return True if the value was added, false if not.
@ -49,9 +53,9 @@ public interface MultiverseWorld {
public boolean addToVariable(String property, String value);
/**
* Removes a value from the given property. The property must be a {@link com.onarandombox.MultiverseCore.commands.AddProperties}.
* Removes a value from the given property. The property must be a {@link com.onarandombox.MultiverseCore.enums.AddProperties}.
*
* @param property The name of a {@link com.onarandombox.MultiverseCore.commands.AddProperties} to remove a value
* @param property The name of a {@link com.onarandombox.MultiverseCore.enums.AddProperties} to remove a value
* from.
* @param value A value in string representation, it will be parsed to the correct type.
*