io.github.alshain01.flags.api
Enum AreaPlugin

java.lang.Object
  java.lang.Enum<AreaPlugin>
      io.github.alshain01.flags.api.AreaPlugin

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AreaPlugin>

public enum AreaPlugin
extends java.lang.Enum<AreaPlugin>

Class for acquiring data from the active cuboid system

Enum Constant Summary

DEFAULT

FACTIONS

FACTOID

FLAGS

GRIEF_PREVENTION

INFINITEPLOTS

PLOTME

PRECIOUSSTONES

REGIOS

RESIDENCE

WILDERNESS

WORLDGUARD

Method Summary

static AreaPlugin	getByName(java.lang.String name) Gets the enumeration that matches the case sensitive plugin.yml name.
java.lang.String	getCuboidName() Gets the name of the area division for the cuboid system (i.e.
java.lang.String	getDisplayName() Gets a user friendly string, including spaces, for the plug-in.
java.lang.String	getName() Gets the plug-in name as indicated in it's plugin.yml
boolean	isActive() Gets if the plugin is the currently active plugin
boolean	isAdministrator() Gets if the plugin supports administrator areas
boolean	isCuboid() Gets if the plugin uses only rectangle or cuboid land divisions
boolean	isIdentifiable() Gets if the plugin identifies areas by UUID
boolean	isOwnable() Gets if the plugin supports players owning areas
boolean	isRenameable() Gets if the plugin supports changing the name of areas after their creation
boolean	isSiegeable() Gets if the plugin supports siegeable areas
boolean	isSubdividable() Gets if the plugin supports subdivisions
static AreaPlugin	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AreaPlugin[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final AreaPlugin DEFAULT

WILDERNESS

public static final AreaPlugin WILDERNESS

FACTIONS

public static final AreaPlugin FACTIONS

FACTOID

public static final AreaPlugin FACTOID

FLAGS

public static final AreaPlugin FLAGS

GRIEF_PREVENTION

public static final AreaPlugin GRIEF_PREVENTION

INFINITEPLOTS

public static final AreaPlugin INFINITEPLOTS

PLOTME

public static final AreaPlugin PLOTME

PRECIOUSSTONES

public static final AreaPlugin PRECIOUSSTONES

REGIOS

public static final AreaPlugin REGIOS

RESIDENCE

public static final AreaPlugin RESIDENCE

WORLDGUARD

public static final AreaPlugin WORLDGUARD

Method Detail

values

public static AreaPlugin[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AreaPlugin c : AreaPlugin.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AreaPlugin valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getName

public java.lang.String getName()

Gets the plug-in name as indicated in it's plugin.yml

Returns:

The case sensitive plugin.yml name for the enumerated value

getDisplayName

public java.lang.String getDisplayName()

Gets a user friendly string, including spaces, for the plug-in.

Returns:

The user friendly name of the plugin

getCuboidName

public java.lang.String getCuboidName()

Gets the name of the area division for the cuboid system (i.e. Claim, Residence, Territory, Region, etc.)

Returns:

The name of the area division

getByName

public static AreaPlugin getByName(@Nonnull
                                   java.lang.String name)

Gets the enumeration that matches the case sensitive plugin.yml name.

Returns:

The enumeration. AreaPlugin.FLAGS if no matches found.

isActive

public boolean isActive()

Gets if the plugin is the currently active plugin

Returns:

true if the plugin is active

isSubdividable

public boolean isSubdividable()

Gets if the plugin supports subdivisions

Returns:

true if the cuboid plugin supports subdivisions.

isRenameable

public boolean isRenameable()

Gets if the plugin supports changing the name of areas after their creation

Returns:

true if the cuboid plugin supports renaming areas.

isAdministrator

public boolean isAdministrator()

Gets if the plugin supports administrator areas

Returns:

true if the cuboid plugin supports administrator areas.

isOwnable

public boolean isOwnable()

Gets if the plugin supports players owning areas

Returns:

true if the cuboid plugin supports players owning areas.

isSiegeable

public boolean isSiegeable()

Gets if the plugin supports siegeable areas

Returns:

true if the cuboid plugin supports siegeable areas.

isIdentifiable

public boolean isIdentifiable()

Gets if the plugin identifies areas by UUID

Returns:

true if the cuboid plugin identifies areas by UUID.

isCuboid

public boolean isCuboid()

Gets if the plugin uses only rectangle or cuboid land divisions

Returns:

true if the cuboid plugin uses rectangle based cuboids.