ucar.nc2

Interface AttributeContainer

All Known Implementing Classes:

AttributeContainerHelper, CoordinateAxis, CoordinateAxis1D, CoordinateAxis1DTime, CoordinateAxis2D, CoverageTransform, Group, Sequence, SequenceDS, Structure, StructureDS, StructurePseudo2Dim, StructurePseudoDS, Variable, VariableDS

public interface AttributeContainer

Container of Attributes

Since:

3/20/14

Method Summary

Modifier and Type	Method and Description
void	addAll(Iterable<Attribute> atts) Add all; replace old if has same name
Attribute	addAttribute(Attribute att) Add new or replace old if has same name
Attribute	findAttribute(String attName)
Attribute	findAttributeIgnoreCase(String attName)
String	findAttValueIgnoreCase(String attName, String defaultValue) Find a String-valued Attribute by Attribute name (ignore case), return the (string) value of the Attribute.
List<Attribute>	getAttributes() Returns the list of attributes for this variable.
String	getName()
boolean	remove(Attribute a) Remove an Attribute : uses the attribute hashCode to find it.
boolean	removeAttribute(String attName) Remove an Attribute by name.
boolean	removeAttributeIgnoreCase(String attName) Remove an Attribute by name, ignoring case

Method Detail

getAttributes

List<Attribute> getAttributes()

Returns the list of attributes for this variable.

Returns:

list of attributes, immutable

addAll

void addAll(Iterable<Attribute> atts)

Add all; replace old if has same name

addAttribute

Attribute addAttribute(Attribute att)

Add new or replace old if has same name

Parameters:

att - add this Attribute

Returns:

the added attribute

findAttValueIgnoreCase

String findAttValueIgnoreCase(String attName,
                              String defaultValue)

Find a String-valued Attribute by Attribute name (ignore case), return the (string) value of the Attribute.

Returns:

the attribute value, or defaultValue if not found

findAttribute

Attribute findAttribute(String attName)

findAttributeIgnoreCase

Attribute findAttributeIgnoreCase(String attName)

getName

String getName()

remove

boolean remove(Attribute a)

Remove an Attribute : uses the attribute hashCode to find it.

Parameters:

a - remove this attribute

Returns:

true if was found and removed

removeAttribute

boolean removeAttribute(String attName)

Remove an Attribute by name.

Parameters:

attName - if exists, remove this attribute

Returns:

true if was found and removed

removeAttributeIgnoreCase

boolean removeAttributeIgnoreCase(String attName)

Remove an Attribute by name, ignoring case

Parameters:

attName - if exists, remove this attribute

Returns:

true if was found and removed