Android - An Open Handset Alliance Project

java.lang
public abstract class

java.lang.Enum

java.lang.Object
	java.lang.Enum	Serializable Comparable

The superclass of all enumerated types.

Known Direct Subclasses

Adapter.Mode, Authenticator.RequestorType, Bitmap.CompressFormat, Bitmap.Config, BlurMaskFilter.Blur, Canvas.EdgeType, Connection.State, ElementType, Formatter.BigDecimalLayoutForm, GradientDrawable.Orientation, ImageView.ScaleType, Interpolator.Result, KeyRep.Type, Layout.Alignment, MapView.DeviceType, MapView.ReticleDrawMode, Matrix.ScaleToFit, Paint.Align, Paint.Cap, Paint.Join, Paint.Style, Path.Direction, Path.FillType, PathDashPathEffect.Style, PorterDuff.Mode, Proxy.Type, Region.Op, RetentionPolicy, RoundingMode, SSLEngineResult.HandshakeStatus, SSLEngineResult.Status, ServiceState.State, Shader.TileMode, SmsMessage.MessageClass, TelephoneNumberUtil.Flags, TextInputMethod.Capitalize, TextUtils.TruncateAt, TextView.BufferType, Thread.State, TimeUnit, WebSettings.LayoutAlgorithm, WebSettings.TextSize, Xml.Encoding

Summary

Protected Constructors

					Enum(String name, int ordinal)
					Constructor for enum subtypes.

Public Methods

final		int	compareTo(E o)
			Answers the comparative ordering of the receiver and the given argument.
final		boolean	equals(Object other)
			Answers true only if the receiver is equal to the argument.
final		Class	getDeclaringClass()
			Answers the enum constant's declaring class.
final		int	hashCode()
			Answers the hash of the receiver.
final		String	name()
			Answers the name of the enum constant.
final		int	ordinal()
			Answers the position of the enum constant in the declaration.
		String	toString()
			Answer a string representation of the receiver suitable for display to a programmer.
	static	T	valueOf(Class enumType, String name)
			Answers the named constant of the given enum type.

Protected Methods

		final		Object	clone()
					Enums are singletons, they may not be cloned.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface java.lang.Comparable

compareTo

Details

Protected Constructors

protected Enum(String name, int ordinal)

Constructor for enum subtypes.

Parameters

name	the enum constant declared name.
ordinal	the enum constant position ordinal.

Public Methods

public final int compareTo(E o)

Answers the comparative ordering of the receiver and the given argument. If the receiver is naturally ordered before the actual argument then the result is negative, if the receiver is naturally ordered in equal position to the actual argument then the result is zero, and if the receiver is naturally ordered after the actual argument then the result is positive.

Returns

negative, zero, or positive value depending upon before, equal, or after natural order respectively.

public final boolean equals(Object other)

Answers true only if the receiver is equal to the argument. Since enums are unique this is equivalent to an identity test.

Parameters

other	Object the object to compare with this object.

Returns

true if the receiver and argument are equal, otherwise return false.

public final Class getDeclaringClass()

Answers the enum constant's declaring class.

Returns

the class object representing the constant's enum type.

public final int hashCode()

Answers the hash of the receiver.

Returns

the hash code.

public final String name()

Answers the name of the enum constant. The name is the field as it appears in the Enum declaration.

Returns

the precise enum constant name.

public final int ordinal()

Answers the position of the enum constant in the declaration. The first constant has and ordinal value of zero.

Returns

the constant's ordinal value.

public String toString()

Answer a string representation of the receiver suitable for display to a programmer.

Returns

the displayable string name.

public static T valueOf(Class enumType, String name)

Answers the named constant of the given enum type.

Parameters

enumType	the class of the enumerated type to search for the constant value.
name	the name of the constant value to find.

Returns

the enum constant

Throws

NullPointerException	if either the `enumType` or `name` are `null`.
IllegalArgumentException	if `enumType` is not an enumerated type or does not have a constant value called `name`.

Protected Methods

protected final Object clone()

Enums are singletons, they may not be cloned. This method always throws a CloneNotSupportedException.

Returns

does not return.

Throws

CloneNotSupportedException

Adapter.Mode
Authenticator.RequestorType	an enum class of requestor type
Bitmap.CompressFormat	Specifies the known formats a bitmap can be compressed into
Bitmap.Config
BlurMaskFilter.Blur
Canvas.EdgeType
Connection.State
ElementType	An enumeration of element types.
Formatter.BigDecimalLayoutForm
GradientDrawable.Orientation	Controls how the gradient is oriented relative to the drawable's bounds
ImageView.ScaleType
Interpolator.Result
KeyRep.Type	Supported key types
Layout.Alignment
MapView.DeviceType	Distinguishes what type of device initiated an event.
MapView.ReticleDrawMode	Allow the user to specify the mode in which the reticle is drawn
Matrix.ScaleToFit	Controlls how the src rect should align into the dst rect for setRectToRect().
Paint.Align	Align specifies how drawText aligns its text relative to the [[]x,y] coordinates.
Paint.Cap	The Cap specifies the treatment for the beginning and ending of stroked lines and paths.
Paint.Join	The Join specifies the treatment where lines and curve segments join on a stroked path.
Paint.Style	The Style specifies if the primitive being drawn is filled, stroked, or both (in the same color).
Path.Direction	Specifies how closed shapes (e.g.
Path.FillType	Enum for the ways a path may be filled
PathDashPathEffect.Style
PorterDuff.Mode
Proxy.Type	The proxy type, includes `DIRECT`, `HTTP` and `SOCKS`.
Region.Op
RetentionPolicy	An enumeration for annotation retention policies.
RoundingMode	An enum to specify the rounding behaviour for operations whose results cannot be represented exactly.
SSLEngineResult.HandshakeStatus
SSLEngineResult.Status
ServiceState.State	The servcie state enums of phone.
Shader.TileMode
SmsMessage.MessageClass	SMS Class enumeration.
TelephoneNumberUtil.Flags	Flags which modify the default phone number presentation IDD is the International Direct Dial code, "011" in the US NDD is the National Direct Dial code, "1" in the US
TextInputMethod.Capitalize
TextUtils.TruncateAt
TextView.BufferType
Thread.State	A representation of a thread's state.
TimeUnit	A `TimeUnit` represents time durations at a given unit of granularity and provides utility methods to convert across units, and to perform timing and delay operations in these units.
WebSettings.LayoutAlgorithm	Enum for controlling the layout of html.
WebSettings.TextSize	Enum for specifying the text size.
Xml.Encoding	Supported character encodings.

				int	compareTo(T another)
					Answers an integer indicating the relative positions of the receiver and the argument in the natural order of elements of the receiver's class.


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

java.lang.Enum

Known Direct Subclasses

Summary

Protected Constructors

Public Methods

Protected Methods

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Comparable

Details

Protected Constructors

protected Enum(String name, int ordinal)

Parameters

Public Methods

public final int compareTo(E o)

Returns

See Also

public final boolean equals(Object other)

Parameters

Returns

public final Class getDeclaringClass()

Returns

public final int hashCode()

Returns

public final String name()

Returns

See Also

public final int ordinal()

Returns

public String toString()

Returns

public static T valueOf(Class enumType, String name)

Parameters

Returns

Throws

Protected Methods

protected final Object clone()

Returns

Throws