File	Doc	Category	Size	Date	Package
Enum.java	API Doc	Android 1.5 API	7847	Wed May 06 22:41:04 BST 2009	java.lang

Enum

• java.lang.Object

Fields Summary
private static final long	serialVersionUID
private final String	name
private final int	ordinal

Constructors Summary
protected Enum(String name, int ordinal) Constructor for constants of enum subtypes. param name the enum constant's declared name. param ordinal the enum constant's ordinal, which corresponds to its position in the enum declaration, starting at zero. since Android 1.0 this.name = name; this.ordinal = ordinal;

Methods Summary
protected final java.lang.Object	clone() {@code Enum} objects are singletons, they may not be cloned. This method always throws a {@code CloneNotSupportedException}. return does not return. throws CloneNotSupportedException is always thrown. since Android 1.0 // KA004=Enums may not be cloned throw new CloneNotSupportedException(Msg.getString("KA004")); //$NON-NLS-1$
public final int	compareTo(E o) Compares this object to the specified enum object to determine their relative order. This method compares the object's ordinal values, that is, their position in the enum declaration. param o the enum object to compare this object to. return a negative value if the ordinal value of this enum constant is less than the ordinal value of {@code o}; 0 if the ordinal values of this enum constant and {@code o} are equal; a positive value if the ordinal value of this enum constant is greater than the ordinal value of {@code o}. see java.lang.Comparable since Android 1.0 return ordinal - o.ordinal;
public final boolean	equals(java.lang.Object other) Compares this object with the specified object and indicates if they are equal. In order to be equal, {@code object} must be identical to this enum constant. param other the object to compare this enum constant with. return {@code true} if the specified object is equal to this {@code Enum}; {@code false} otherwise. since Android 1.0 return this == other;
public final java.lang.Class	getDeclaringClass() Returns the enum constant's declaring class. return the class object representing the constant's enum type. since Android 1.0 Class<?> myClass = getClass(); Class<?> mySuperClass = myClass.getSuperclass(); if (Enum.class == mySuperClass) { return (Class<E>)myClass; } return (Class<E>)mySuperClass;
static T[]	getValues(java.lang.Class enumType) try { Method values = AccessController .doPrivileged(new PrivilegedExceptionAction<Method>() { public Method run() throws Exception { Method valsMethod = enumType.getMethod("values", //$NON-NLS-1$ (Class[]) null); valsMethod.setAccessible(true); return valsMethod; } }); return (T[]) values.invoke(enumType, (Object[])null); } catch (Exception e) { return null; }
public final int	hashCode() return ordinal + (name == null ? 0 : name.hashCode());
public final java.lang.String	name() Returns the name of this enum constant. The name is the field as it appears in the {@code enum} declaration. return the name of this enum constant. see #toString() since Android 1.0 return name;
public final int	ordinal() Returns the position of the enum constant in the declaration. The first constant has an ordinal value of zero. return the ordinal value of this enum constant. since Android 1.0 return ordinal;
public java.lang.String	toString() Returns a string containing a concise, human-readable description of this object. In this case, the enum constant's name is returned. return a printable representation of this object. since Android 1.0 return name;
public static T	valueOf(java.lang.Class enumType, java.lang.String name) Returns the constant with the specified name of the specified enum type. param enumType the class of the enumerated type to search for the constant value. param name the name of the constant value to find. return the enum constant. throws NullPointerException if either {@code enumType} or {@code name} are {@code null}. throws IllegalArgumentException if {@code enumType} is not an enumerated type or does not have a constant value called {@code name}. since Android 1.0 if ((enumType == null) || (name == null)) { // KA001=Argument must not be null throw new NullPointerException(Msg.getString("KA001")); //$NON-NLS-1$ } // BEGIN android-changed enumType.checkPublicMemberAccess(); T result = enumType.getClassCache().getEnumValue(name); if (result == null) { if (!enumType.isEnum()) { // KA005={0} is not an enum type throw new IllegalArgumentException(Msg.getString("KA005", enumType)); //$NON-NLS-1$ } else { // KA006={0} is not a constant in the enum type {1} throw new IllegalArgumentException(Msg.getString("KA006", name, //$NON-NLS-1$ enumType)); } } return result; // END android-changed