org.josef.science.physics.astronomy

Enum Planet

java.lang.Object

java.lang.Enum<Planet>

org.josef.science.physics.astronomy.Planet

All Implemented Interfaces:

Serializable, Comparable<Planet>, Localizable, LocalizableEnumeration

@Status(stage=PRODUCTION,
        unitTests=ABSENT)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public enum Planet
extends Enum<Planet>
implements LocalizableEnumeration

Enumeration of all the planets in the Solar System.
This enumeration of planets is localizable. It implements LocalizableEnumeration and it has the accompanying properties files.

Version:

1.0 $Revision: 6230 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
EARTH Earth.
JUPITER Jupiter.
MARS Mars.
MERCURY Mercury.
NEPTUNE Neptune.
SATURN Saturn.
URANUS Uranus.
VENUS Venus.

Method Summary

Modifier and Type	Method and Description
Serializable	getCode() Gets the code of this Planet.
CodeDescription	getCodeDescription(Locale locale) Gets the CodeDescription of this Planet.
static List<CodeDescription>	getCodeDescriptions(Locale locale) Gets a List of CodeDescription objects for all the Planets.
String	getDescription(Locale locale) Gets the localized description of this Planet.
static String	getEnumDescription(Locale locale) Gets the description of this enumeration of planets.
static Planet	valueOf(String name) Returns the enum constant of this type with the specified name.
static Planet[]	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

MERCURY

public static final Planet MERCURY

Mercury.

VENUS

public static final Planet VENUS

Venus.

EARTH

public static final Planet EARTH

Earth.

MARS

public static final Planet MARS

Mars.

JUPITER

public static final Planet JUPITER

Jupiter.

SATURN

public static final Planet SATURN

Saturn.

URANUS

public static final Planet URANUS

Uranus.

NEPTUNE

public static final Planet NEPTUNE

Neptune.

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public Serializable getCode()

Gets the code of this Planet.

Specified by:

getCode in interface LocalizableEnumeration

Returns:

The code of this Planet which is its position from the Sun.
Planets are numbered from 1 on so Earth would return 3.

getDescription

public String getDescription(Locale locale)

Gets the localized description of this Planet.

Specified by:

getDescription in interface Localizable

Specified by:

getDescription in interface LocalizableEnumeration

Parameters:

locale - Locale used to localize the description.
When null is supplied the default locale is used.

Returns:

The localized description of this Planet.

getCodeDescription

public CodeDescription getCodeDescription(Locale locale)

Gets the CodeDescription of this Planet.

Specified by:

getCodeDescription in interface LocalizableEnumeration

Parameters:

locale - Locale used to localize the description.
When null is supplied the default locale is used.

Returns:

The localized CodeDescription of this Planet.

getEnumDescription

public static String getEnumDescription(Locale locale)

Gets the description of this enumeration of planets.

Parameters:

locale - Locale used to localize the description.
When null is supplied the default locale is used.

Returns:

Localized description of this enumeration of planets.

See Also:

CEnumeration.getDescription(Class, Locale)

getCodeDescriptions

public static List<CodeDescription> getCodeDescriptions(Locale locale)

Gets a List of CodeDescription objects for all the Planets.

Parameters:

locale - Locale used to localize the descriptions.
When null is supplied the default locale is used.

Returns:

A List of CodeDescription objects for all the Planets.

See Also:

CEnumeration.getCodeDescriptions(Class, Locale)