ucar.nc2

Interface AttributeContainer

All Superinterfaces:

Iterable<Attribute>

All Known Implementing Classes:

AttributeContainerMutable, CoordinateAxis, CoordinateAxis1D, CoordinateAxis1DTime, CoordinateAxis2D, Group, Sequence, 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
static AttributeContainer	filter(AttributeContainer atts, String... remove) Create a new AttributeContainer, removing any whose name starts with one in the given list.
Attribute	findAttribute(String attName) Find an Attribute by exact match on 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 doing an exact match, then ignoring case.
int	findAttributeInteger(String attName, int defaultValue) Find a Numeric Attribute by name (ignore case), return the integer value of the Attribute.
String	findAttributeString(String attName, String defaultValue) Find a String Attribute by name (ignore case), return the String value of the Attribute.
String	getName() Get the (optional) name of the AttributeContainer.
default boolean	hasAttribute(String attName) Determine if named attribute exists (exact match).
default boolean	hasAttributeIgnoreCase(String attName) Determine if named attribute exists, ignoring case.
boolean	isEmpty() True is there are no attributes in the container.
default Iterator<Attribute>	iterator() An unordered iterator over the contained attributes.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

filter

static AttributeContainer filter(AttributeContainer atts,
                                 String... remove)

Create a new AttributeContainer, removing any whose name starts with one in the given list.

Parameters:

atts - Start with this set of Attributes.

remove - Remove any whose name starts with one of these.

Returns:

new AttributeContainer with attributes removed.

findAttribute

@Nullable
Attribute findAttribute(String attName)

Find an Attribute by exact match on name.

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

findAttributeIgnoreCase

@Nullable
Attribute findAttributeIgnoreCase(String attName)

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

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

findAttributeString

String findAttributeString(String attName,
                           String defaultValue)

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

Returns:

the attribute value, or defaultValue if not found

getName

@Nullable
String getName()

Get the (optional) name of the AttributeContainer.

hasAttribute

default boolean hasAttribute(String attName)

Determine if named attribute exists (exact match).

hasAttributeIgnoreCase

default boolean hasAttributeIgnoreCase(String attName)

Determine if named attribute exists, ignoring case.

isEmpty

boolean isEmpty()

True is there are no attributes in the container.

iterator

default Iterator<Attribute> iterator()

An unordered iterator over the contained attributes.

Specified by:

iterator in interface Iterable<Attribute>