org.bukkit
Enum PortalType

java.lang.Object
  java.lang.Enum<PortalType>
      org.bukkit.PortalType

All Implemented Interfaces:

Serializable, Comparable<PortalType>

public enum PortalType
extends Enum<PortalType>

Represents various types of portals that can be made in a world.

Enum Constant Summary

CUSTOM
This is a custom Plugin portal.

ENDER
This is an Ender portal.

NETHER
This is a Nether portal, made of obsidian.

Method Summary

static PortalType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PortalType[]	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

NETHER

public static final PortalType NETHER

This is a Nether portal, made of obsidian.

ENDER

public static final PortalType ENDER

This is an Ender portal.

CUSTOM

public static final PortalType CUSTOM

This is a custom Plugin portal.

Method Detail

values

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

Returns:

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

valueOf

public static PortalType 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