ucar.nc2

Class EnumTypedef

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.EnumTypedef

@Immutable
public class EnumTypedef
extends CDMNode

A named map from integers to Strings; a user-defined Enum used as a Variable's data type. For ENUM1, ENUM2, ENUM4 enumeration types. Immutable. TODO EnumTypedef will not extend CDMNode in 6. TODO EnumTypedef will not have a reference to its owning Group in 6. TODO EnumTypedef.getFullName() will not exist in 6.

Field Summary

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) Make an EnumTypedef with base type ENUM4.
EnumTypedef(java.lang.String name, java.util.Map<java.lang.Integer,java.lang.String> map, DataType basetype) Make an EnumTypedef setting the base type (must be ENUM1, ENUM2, ENUM4).

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
boolean	equalsMapOnly(java.lang.Object o)
DataType	getBaseType() One of DataType.ENUM1, DataType.ENUM2, or DataType.ENUM4.
com.google.common.collect.ImmutableList<java.lang.String>	getEnumStrings() Deprecated. use getMap()
com.google.common.collect.ImmutableMap<java.lang.Integer,java.lang.String>	getMap()
int	hashCode()
java.lang.Integer	lookupEnumInt(java.lang.String name) Get the enum value corresponding to the name.
java.lang.String	lookupEnumString(int e) Get the name corresponding to the enum value.
java.lang.String	toString()
java.lang.String	writeCDL(boolean strict) Deprecated. use CDLWriter
protected void	writeCDL(java.util.Formatter out, Indent indent, boolean strict) Deprecated. use CDLWriter

Methods inherited from class ucar.nc2.CDMNode

annotate, annotation, 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

Constructor Detail

EnumTypedef

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

Make an EnumTypedef with base type ENUM4.

EnumTypedef

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

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

Method Detail

getEnumStrings

@Deprecated
public com.google.common.collect.ImmutableList<java.lang.String> getEnumStrings()

Deprecated. use getMap()

getMap

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

getBaseType

public DataType getBaseType()

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

lookupEnumString

@Nullable
public java.lang.String lookupEnumString(int e)

Get the name corresponding to the enum value.

lookupEnumInt

@Nullable
public java.lang.Integer lookupEnumInt(java.lang.String name)

Get the enum value corresponding to the name.

writeCDL

@Deprecated
public java.lang.String writeCDL(boolean strict)

Deprecated. use CDLWriter

CDL string representation.

Parameters:

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

Returns:

CDL representation.

writeCDL

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

Deprecated. use CDLWriter

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equalsMapOnly

public boolean equalsMapOnly(java.lang.Object o)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object