ucar.nc2

Class EnumTypedef

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.EnumTypedef

@Immutable
public class EnumTypedef
extends CDMNode

Enumeration Typedef map integers to Strings. For ENUM1, ENUM2, ENUM4 enumeration types. Immutable.

Field Summary

Fields

Modifier and Type	Field and Description
static int	UBYTE_MAX
static int	USHORT_MAX

Fields inherited from class ucar.nc2.CDMNode

annotations, dodsname, group, immutable, parentstruct, shortName, sort

Constructor Summary

Constructors

Constructor and Description
EnumTypedef(java.lang.String name, java.util.Map<java.lang.Integer,java.lang.String> map)
EnumTypedef(java.lang.String name, java.util.Map<java.lang.Integer,java.lang.String> map, DataType basetype)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
DataType	getBaseType()
java.util.List<java.lang.String>	getEnumStrings()
java.util.Map<java.lang.Integer,java.lang.String>	getMap()
int	hashCode()
void	hashCodeShow(Indent indent)
java.lang.String	lookupEnumString(int e)
java.lang.String	toString()
boolean	validateMap(java.util.Map<java.lang.Integer,java.lang.String> map, DataType basetype)
java.lang.String	writeCDL(boolean strict) String representation.
protected void	writeCDL(java.util.Formatter out, Indent indent, boolean strict)

Methods inherited from class ucar.nc2.CDMNode

annotate, getAnnotation, getAnnotations, getDODSName, getFullName, getFullNameEscaped, getGroup, getImmutable, getName, getParentGroup, getParentStructure, getShortName, getSort, isMemberOfStructure, localhash, setDODSName, setImmutable, setParentGroup, setParentStructure, setShortName, setSort, unwrap

Methods inherited from class java.lang.Object

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

Field Detail

UBYTE_MAX

public static final int UBYTE_MAX

See Also:

Constant Field Values

USHORT_MAX

public static final int USHORT_MAX

See Also:

Constant Field Values

Constructor Detail

EnumTypedef

public EnumTypedef(java.lang.String name,
                   java.util.Map<java.lang.Integer,java.lang.String> map)

EnumTypedef

public EnumTypedef(java.lang.String name,
                   java.util.Map<java.lang.Integer,java.lang.String> map,
                   DataType basetype)

Method Detail

getEnumStrings

public java.util.List<java.lang.String> getEnumStrings()

getMap

public java.util.Map<java.lang.Integer,java.lang.String> getMap()

getBaseType

public DataType getBaseType()

validateMap

public boolean validateMap(java.util.Map<java.lang.Integer,java.lang.String> map,
                           DataType basetype)

lookupEnumString

public java.lang.String lookupEnumString(int e)

writeCDL

public java.lang.String writeCDL(boolean strict)

String representation.

Parameters:

strict - if true, write in strict adherence to CDL definition.

Returns:

CDL representation.

writeCDL

protected void writeCDL(java.util.Formatter out,
                        Indent indent,
                        boolean strict)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

hashCodeShow

public void hashCodeShow(Indent indent)

Specified by:

hashCodeShow in class CDMNode

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object