ucar.nc2

Interface AttributeContainer

All Superinterfaces:

Iterable<Attribute>

All Known Implementing Classes:

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

public interface AttributeContainer
extends Iterable<Attribute>

An immutable Container of Attributes. Use AttributeContainerMutable if you want a mutable container.

Method Summary

Modifier and Type	Method and Description
void	addAll(Iterable<Attribute> atts) Deprecated. will be removed in version 6.
Attribute	addAttribute(Attribute att) Deprecated. will be removed in version 6.
Attribute	findAttribute(String attName) Find an Attribute by name
double	findAttributeDouble(String attName, double defaultValue) Find a Numeric Attribute by name (ignore case), return the double value of the Attribute.
Attribute	findAttributeIgnoreCase(String attName) Find an Attribute by name, first try doing an exact match, then try ignoring case.
int	findAttributeInteger(String attName, int defaultValue) Find a Numeric Attribute by name (ignore case), return the integer value of the Attribute.
String	findAttValueIgnoreCase(String attName, String defaultValue) Find a String-valued Attribute by name (ignore case), return the String value of the Attribute.
List<Attribute>	getAttributes() Deprecated. use Iterable
String	getName() Get the (optional) name of the AttributeContainer.
default boolean	hasAttribute(String attName) Determine if named attribute exists.
default Iterator<Attribute>	iterator()
boolean	remove(Attribute a) Deprecated. will be removed in version 6.
boolean	removeAttribute(String attName) Deprecated. will be removed in version 6.
boolean	removeAttributeIgnoreCase(String attName) Deprecated. will be removed in version 6.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

findAttValueIgnoreCase

String findAttValueIgnoreCase(String attName,
                              String defaultValue)

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

Returns:

the attribute value, or defaultValue if not found

findAttributeDouble

double findAttributeDouble(String attName,
                           double defaultValue)

Find a Numeric Attribute by name (ignore case), return the double value of the Attribute.

Returns:

the attribute value, or defaultValue if not found

findAttributeInteger

int findAttributeInteger(String attName,
                         int defaultValue)

Find a Numeric Attribute by name (ignore case), return the integer value of the Attribute.

Returns:

the attribute value, or defaultValue if not found

findAttribute

@Nullable
Attribute findAttribute(String attName)

Find an Attribute by name

hasAttribute

default boolean hasAttribute(String attName)

Determine if named attribute exists.

findAttributeIgnoreCase

@Nullable
Attribute findAttributeIgnoreCase(String attName)

Find an Attribute by name, first try doing an exact match, then try ignoring case.

getName

@Nullable
String getName()

Get the (optional) name of the AttributeContainer.

iterator

default Iterator<Attribute> iterator()

Specified by:

iterator in interface Iterable<Attribute>

getAttributes

@Deprecated
List<Attribute> getAttributes()

Deprecated. use Iterable

Returns immutable list of attributes.

addAll

@Deprecated
void addAll(Iterable<Attribute> atts)

Deprecated. will be removed in version 6.

Add all; replace old if has same name

addAttribute

@Deprecated
Attribute addAttribute(Attribute att)

Deprecated. will be removed in version 6.

Add new or replace old if has same name

Parameters:

att - add this Attribute

Returns:

the added attribute

remove

@Deprecated
boolean remove(Attribute a)

Deprecated. will be removed in version 6.

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

Parameters:

a - remove this attribute

Returns:

true if was found and removed

removeAttribute

@Deprecated
boolean removeAttribute(String attName)

Deprecated. will be removed in version 6.

Remove an Attribute by name.

Parameters:

attName - if exists, remove this attribute

Returns:

true if was found and removed

removeAttributeIgnoreCase

@Deprecated
boolean removeAttributeIgnoreCase(String attName)

Deprecated. will be removed in version 6.

Remove an Attribute by name, ignoring case

Parameters:

attName - if exists, remove this attribute

Returns:

true if was found and removed