org.josef.science.physics.particle

Enum Spin

java.lang.Object

java.lang.Enum<Spin>

org.josef.science.physics.particle.Spin

All Implemented Interfaces:

Serializable, Comparable<Spin>

@Status(stage=PRODUCTION,
        unitTests=ABSENT)
 @Review(by="Kees Schotanus",
        at="2010-08-17",
        reason="Initial review")
public enum Spin
extends Enum<Spin>

Enumeration of all the possible spin values of a subatomic particle.
For detailed information read the article on Spin at Wikipedia by clicking here.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
MINUS_ONE_HALF -1/2.
ONE 1.
ONE_HALF 1/2.
TWO 2.
ZERO 0.

Method Summary

Modifier and Type	Method and Description
CRational	getSpin() Gets the Spin as a fraction.
String	toString() Creates a String representation of this Spin.
static Spin	valueOf(String name) Returns the enum constant of this type with the specified name.
static Spin[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MINUS_ONE_HALF

public static final Spin MINUS_ONE_HALF

-1/2.

ZERO

public static final Spin ZERO

0.

ONE_HALF

public static final Spin ONE_HALF

1/2.

ONE

public static final Spin ONE

1.

TWO

public static final Spin TWO

2.

Method Detail

values

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

Returns:

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

valueOf

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

getSpin

public CRational getSpin()

Gets the Spin as a fraction.

Returns:

The Spin as a fraction.

toString

public String toString()

Creates a String representation of this Spin.

Overrides:

toString in class Enum<Spin>

Returns:

A String representation of this Spin.

See Also:

CRational.toString()