edu.nrao.sss.model.resource
Enum AntennaSpecifier

java.lang.Object
  java.lang.Enum<AntennaSpecifier>
      edu.nrao.sss.model.resource.AntennaSpecifier

All Implemented Interfaces:

Serializable, Comparable<AntennaSpecifier>

public enum AntennaSpecifier
extends Enum<AntennaSpecifier>

A list of ways to identify an antenna.

CVS Info:

$Revision: 161 $

$Date: 2006-12-15 11:48:34 -0700 (Fri, 15 Dec 2006) $

$Author: btruitt $

Since:

2006-12-11

Author:

David M. Harland

Enum Constant Summary

ANTENNA_ID
Indicates that an antenna has been specified via its own ID.

PAD_ID
Indicates that an antenna has been specified via the ID of its pad.

Method Summary

static AntennaSpecifier	fromString(String text) Returns the antenna specifier represented by text.
static AntennaSpecifier	getDefault() Returns the default antenna specifier.
String	toString() Returns a text representation of this enumeration constant.
static AntennaSpecifier	valueOf(String name) Returns the enum constant of this type with the specified name.
static AntennaSpecifier[]	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

ANTENNA_ID

public static final AntennaSpecifier ANTENNA_ID

Indicates that an antenna has been specified via its own ID.

PAD_ID

public static final AntennaSpecifier PAD_ID

Indicates that an antenna has been specified via the ID of its pad.

Method Detail

values

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

Returns:

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

valueOf

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

getDefault

public static AntennaSpecifier getDefault()

Returns the default antenna specifier.

Returns:

the default antenna specifier.

toString

public String toString()

Returns a text representation of this enumeration constant.

Overrides:

toString in class Enum<AntennaSpecifier>

Returns:

a text representation of this enumeration constant.

fromString

public static AntennaSpecifier fromString(String text)

Returns the antenna specifier represented by text.

For details about the transformation, see EnumerationUtility.enumFromString(Class, String).

Parameters:

text - a text representation of an antenna specifier.

Returns:

the antenna specifier represented by text.