ucar.nc2

Class EnumTypedef

java.lang.Object

ucar.nc2.EnumTypedef

@Immutable
public class EnumTypedef
extends Object

A named map from integers to Strings; a user-defined Enum used as a Variable's data type. For ENUM1, ENUM2, ENUM4 enumeration types.

Constructor Summary

Constructors

Constructor and Description
EnumTypedef(String name, Map<Integer,String> map) Make an EnumTypedef with base type ENUM4.
EnumTypedef(String name, Map<Integer,String> map, ArrayType basetype) Make an EnumTypedef setting the base type (must be ENUM1, ENUM2, ENUM4).
EnumTypedef(String name, Map<Integer,String> map, DataType basetype) Deprecated. use EnumTypedef(String name, Map map, ArrayType basetype)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
boolean	equalsMapOnly(Object o)
ArrayType	getBaseArrayType() One of ArrayType.ENUM1, ArrayType.ENUM2, or ArrayType.ENUM4.
DataType	getBaseType() Deprecated. use getBaseArrayType()
com.google.common.collect.ImmutableMap<Integer,String>	getMap()
String	getShortName()
int	hashCode()
Integer	lookupEnumInt(String name) Get the enum value corresponding to the name.
String	lookupEnumString(int e) Get the name corresponding to the enum value.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnumTypedef

public EnumTypedef(String name,
                   Map<Integer,String> map)

Make an EnumTypedef with base type ENUM4.

EnumTypedef

@Deprecated
public EnumTypedef(String name,
                                Map<Integer,String> map,
                                DataType basetype)

Deprecated. use EnumTypedef(String name, Map map, ArrayType basetype)

EnumTypedef

public EnumTypedef(String name,
                   Map<Integer,String> map,
                   ArrayType basetype)

Make an EnumTypedef setting the base type (must be ENUM1, ENUM2, ENUM4).

Method Detail

getBaseType

@Deprecated
public DataType getBaseType()

Deprecated. use getBaseArrayType()

getBaseArrayType

public ArrayType getBaseArrayType()

One of ArrayType.ENUM1, ArrayType.ENUM2, or ArrayType.ENUM4.

getShortName

public String getShortName()

getMap

public com.google.common.collect.ImmutableMap<Integer,String> getMap()

lookupEnumInt

@Nullable
public Integer lookupEnumInt(String name)

Get the enum value corresponding to the name.

lookupEnumString

@Nullable
public String lookupEnumString(int e)

Get the name corresponding to the enum value.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

equalsMapOnly

public boolean equalsMapOnly(Object o)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object