org.bukkit.event.world
Enum PortalCreateEvent.CreateReason

java.lang.Object
  java.lang.Enum<PortalCreateEvent.CreateReason>
      org.bukkit.event.world.PortalCreateEvent.CreateReason

All Implemented Interfaces:

Serializable, Comparable<PortalCreateEvent.CreateReason>

Enclosing class:

PortalCreateEvent

public static enum PortalCreateEvent.CreateReason
extends Enum<PortalCreateEvent.CreateReason>

An enum to specify the various reasons for a portal's creation

Enum Constant Summary

FIRE
When a portal is created 'traditionally' due to a portal frame being set on fire.

OBC_DESTINATION
When a portal is created as a destination for an existing portal when using the custom PortalTravelAgent

Method Summary

static PortalCreateEvent.CreateReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static PortalCreateEvent.CreateReason[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIRE

public static final PortalCreateEvent.CreateReason FIRE

When a portal is created 'traditionally' due to a portal frame being set on fire.

OBC_DESTINATION

public static final PortalCreateEvent.CreateReason OBC_DESTINATION

When a portal is created as a destination for an existing portal when using the custom PortalTravelAgent

Method Detail

values

public static PortalCreateEvent.CreateReason[] 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 (PortalCreateEvent.CreateReason c : PortalCreateEvent.CreateReason.values())
    System.out.println(c);

Returns:

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

valueOf

public static PortalCreateEvent.CreateReason valueOf(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:

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

NullPointerException - if the argument is null