Package ucar.nc2

Class AttributeContainerMutable

java.lang.Object

ucar.nc2.AttributeContainerMutable

All Implemented Interfaces:

Iterable<Attribute>, AttributeContainer

public class AttributeContainerMutable
extends Object
implements AttributeContainer

A mutable collection of Attributes.

Constructor Summary

Constructors

Constructor	Description
AttributeContainerMutable(String name)	Constructor with container name.
AttributeContainerMutable(String name, Iterable<Attribute> from)	Constructor with container name and list of Attributes to copy in.

Method Summary

Modifier and Type	Method	Description
void	addAll(Iterable<Attribute> atts)	Add all; replace old if has same name.
Attribute	addAttribute(String name, Number value)	Add Attribute; name and value must not be null.
Attribute	addAttribute(String name, String value)	Add Attribute; name and value must not be null.
Attribute	addAttribute(Attribute att)	Add new or replace old if has same name
static AttributeContainerMutable	copyFrom(AttributeContainer from)	Create mutable from immutable container.
Attribute	findAttribute(String name)	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 name)	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.
List<Attribute>	getAttributes()	Returns immutable list of attributes.
String	getName()	Get the (optional) name of the AttributeContainer.
boolean	isEmpty()	True is there are no attributes in the container.
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
void	replace(Attribute a, String newName)	Replace an Attribute with a different name, same value.
void	setImmutable()	Deprecated. do not use.
void	setName(String name)
AttributeContainer	toImmutable()	Turn into an immutable AttributeContainer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ucar.nc2.AttributeContainer

findAttValueIgnoreCase, hasAttribute, hasAttributeIgnoreCase, iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AttributeContainerMutable

public AttributeContainerMutable(@Nullable
                                 String name)

Constructor with container name.

AttributeContainerMutable

public AttributeContainerMutable(@Nullable
                                 String name,
                                 Iterable<Attribute> from)

Constructor with container name and list of Attributes to copy in.

Method Detail

copyFrom

public static AttributeContainerMutable copyFrom(@Nullable
                                                 AttributeContainer from)

Create mutable from immutable container.

setName

public void setName(@Nullable
                    String name)

getName

@Nullable
public String getName()

Description copied from interface: AttributeContainer

Get the (optional) name of the AttributeContainer.

Specified by:

getName in interface AttributeContainer

setImmutable

@Deprecated
public void setImmutable()

Deprecated.

do not use.

getAttributes

public List<Attribute> getAttributes()

Description copied from interface: AttributeContainer

Returns immutable list of attributes.

Specified by:

getAttributes in interface AttributeContainer

addAttribute

public Attribute addAttribute(Attribute att)

Description copied from interface: AttributeContainer

Add new or replace old if has same name

Specified by:

addAttribute in interface AttributeContainer

Parameters:

att - add this Attribute

Returns:

the added attribute

addAttribute

public Attribute addAttribute(String name,
                              String value)

Add Attribute; name and value must not be null.

addAttribute

public Attribute addAttribute(String name,
                              Number value)

Add Attribute; name and value must not be null.

addAll

public void addAll(Iterable<Attribute> atts)

Add all; replace old if has same name.

Specified by:

addAll in interface AttributeContainer

findAttributeString

public String findAttributeString(String attName,
                                  String defaultValue)

Description copied from interface: AttributeContainer

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

Specified by:

findAttributeString in interface AttributeContainer

Returns:

the attribute value, or defaultValue if not found

findAttribute

public Attribute findAttribute(String name)

Description copied from interface: AttributeContainer

Find an Attribute by exact match on name.

Specified by:

findAttribute in interface AttributeContainer

findAttributeIgnoreCase

public Attribute findAttributeIgnoreCase(String name)

Description copied from interface: AttributeContainer

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

Specified by:

findAttributeIgnoreCase in interface AttributeContainer

findAttributeDouble

public double findAttributeDouble(String attName,
                                  double defaultValue)

Description copied from interface: AttributeContainer

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

Specified by:

findAttributeDouble in interface AttributeContainer

Returns:

the attribute value, or defaultValue if not found

findAttributeInteger

public int findAttributeInteger(String attName,
                                int defaultValue)

Description copied from interface: AttributeContainer

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

Specified by:

findAttributeInteger in interface AttributeContainer

Returns:

the attribute value, or defaultValue if not found

remove

public boolean remove(Attribute a)

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

Specified by:

remove in interface AttributeContainer

Parameters:

a - remove this attribute

Returns:

true if was found and removed

replace

public void replace(Attribute a,
                    String newName)

Replace an Attribute with a different name, same value.

Parameters:

a - remove this attribute

removeAttribute

public boolean removeAttribute(String attName)

Remove an Attribute by name.

Specified by:

removeAttribute in interface AttributeContainer

Parameters:

attName - if exists, remove this attribute

Returns:

true if was found and removed

removeAttributeIgnoreCase

public boolean removeAttributeIgnoreCase(String attName)

Remove an Attribute by name, ignoring case

Specified by:

removeAttributeIgnoreCase in interface AttributeContainer

Parameters:

attName - if exists, remove this attribute

Returns:

true if was found and removed

toImmutable

public AttributeContainer toImmutable()

Turn into an immutable AttributeContainer

isEmpty

public boolean isEmpty()

Description copied from interface: AttributeContainer

True is there are no attributes in the container.

Specified by:

isEmpty in interface AttributeContainer