org.bukkit.BanEntry Maven / Gradle / Ivy
package org.bukkit;
import java.util.Date;
/**
* A single entry from a ban list. This may represent either a player ban or
* an IP ban.
*
* Ban entries include the following properties:
*
* Property information
*
* Property
* Description
*
* Target Name / IP Address
* The target name or IP address
*
* Creation Date
* The creation date of the ban
*
* Source
* The source of the ban, such as a player, console, plugin, etc
*
* Expiration Date
* The expiration date of the ban
*
* Reason
* The reason for the ban
*
*
*
* Unsaved information is not automatically written to the implementation's
* ban list, instead, the {@link #save()} method must be called to write the
* changes to the ban list. If this ban entry has expired (such as from an
* unban) and is no longer found in the list, the {@link #save()} call will
* re-add it to the list, therefore banning the victim specified.
*
* Likewise, changes to the associated {@link BanList} or other entries may or
* may not be reflected in this entry.
*/
public interface BanEntry {
/**
* Gets the target involved. This may be in the form of an IP or a player
* name.
*
* @return the target name or IP address
*/
String getTarget();
/**
* Gets the date this ban entry was created.
*
* @return the creation date
*/
Date getCreated();
/**
* Sets the date this ban entry was created.
*
* @param created the new created date, cannot be null
* @see #save() saving changes
*/
void setCreated(Date created);
/**
* Gets the source of this ban.
*
* Note: A source is considered any String, although this is generally a
* player name.
*
* @return the source of the ban
*/
String getSource();
/**
* Sets the source of this ban.
*
* Note: A source is considered any String, although this is generally a
* player name.
*
* @param source the new source where null values become empty strings
* @see #save() saving changes
*/
void setSource(String source);
/**
* Gets the date this ban expires on, or null for no defined end date.
*
* @return the expiration date
*/
Date getExpiration();
/**
* Sets the date this ban expires on. Null values are considered
* "infinite" bans.
*
* @param expiration the new expiration date, or null to indicate an
* eternity
* @see #save() saving changes
*/
void setExpiration(Date expiration);
/**
* Gets the reason for this ban.
*
* @return the ban reason, or null if not set
*/
String getReason();
/**
* Sets the reason for this ban. Reasons must not be null.
*
* @param reason the new reason, null values assume the implementation
* default
* @see #save() saving changes
*/
void setReason(String reason);
/**
* Saves the ban entry, overwriting any previous data in the ban list.
*
* Saving the ban entry of an unbanned player will cause the player to be
* banned once again.
*/
void save();
}