Attribute (cdm-core 6.0.0-beta1 API)

java.lang.Object
- ucar.nc2.Attribute

```
@Immutable
public class Attribute
extends Object
```
An Attribute is a name and a value, used for associating arbitrary metadata with another object. The value can be a one dimensional array of Strings or numeric values. LOOK: support for OPAQUE attributes?

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Attribute.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Attribute.Builder`

Constructor Summary

Constructors
Constructor and Description
`Attribute(String name, Number val)` Create a scalar, signed, numeric-valued Attribute.
`Attribute(String name, String val)` Create a String-valued Attribute.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Attribute.Builder`	`builder()` Create an Attribute builder.
`static Attribute.Builder`	`builder(String name)` Create an Attribute builder with the given Attribute name.
`static Attribute`	`emptyValued(String name, ArrayType dtype)` Create an Attribute with a datatype but no value.
`static Attribute`	`emptyValued(String name, DataType dtype)` Deprecated. use emptyValued(String name, ArrayType dtype)
`boolean`	`equals(Object o)`
`static Attribute`	`fromArray(String name, Array values)` Deprecated. use fromArray(String name, Array values)
`static Attribute`	`fromArray(String name, Array<?> values)` Create an Attribute from an Array.
`static Attribute`	`fromParameter(Parameter param)` Create an Attribute from a ucar.unidata.util.Parameter.
`ArrayType`	`getArrayType()` Get the data type of the Attribute value.
`Array<?>`	`getArrayValues()` Get the values as an ucar.array.Array.
`DataType`	`getDataType()` Deprecated. use getArrayType()
`EnumTypedef`	`getEnumType()` Get the EnumTypedef of the Attribute value, if DataType is an ENUM.
`int`	`getLength()` Get the length of the array of values
`String`	`getName()` Get the Attribute name, same as the short name.
`Number`	`getNumericValue()` Retrieve first numeric value.
`Number`	`getNumericValue(int index)` Retrieve a numeric value by index.
`String`	`getShortName()` Get the Attribute name.
`String`	`getStringValue()` Retrieve first String value if this is a String valued attribute, else null.
`String`	`getStringValue(int index)` Retrieve ith String value; only call if isString() is true.
`Object`	`getValue(int index)` Get the value as an Object (String or Number).
`Array`	`getValues()` Get the values as an ucar.ma2.Array.
`int`	`hashCode()`
`boolean`	`isArray()` True if value is an array (getLength() > 1)
`boolean`	`isString()` True if value is of type String and not null.
`Attribute.Builder`	`toBuilder()` Turn into a mutable Builder.
`static Parameter`	`toParameter(Attribute att)` Create an Attribute from a ucar.unidata.util.Parameter.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Attribute
```
public Attribute(String name,
                 @Nullable
                 String val)
```
    Create a String-valued Attribute.
    
    Parameters:
    
    name - name of Attribute
    
    val - value of Attribute
  - Attribute
```
public Attribute(String name,
                 Number val)
```
    Create a scalar, signed, numeric-valued Attribute. Use builder for unsigned.
    
    Parameters:
    
    name - name of Attribute
    
    val - value of Attribute, assumed unsigned.
- Method Detail
  - fromParameter
```
public static Attribute fromParameter(Parameter param)
```
    Create an Attribute from a ucar.unidata.util.Parameter.
  - toParameter
```
public static Parameter toParameter(Attribute att)
```
    Create an Attribute from a ucar.unidata.util.Parameter.
  - fromArray
```
@Deprecated
public static Attribute fromArray(String name,
                                               Array values)
```
    Deprecated. use fromArray(String name, Array values)
  - fromArray
```
public static Attribute fromArray(String name,
                                  Array<?> values)
```
    Create an Attribute from an Array.
  - emptyValued
```
@Deprecated
public static Attribute emptyValued(String name,
                                                 DataType dtype)
```
    Deprecated. use emptyValued(String name, ArrayType dtype)
  - emptyValued
```
public static Attribute emptyValued(String name,
                                    ArrayType dtype)
```
    Create an Attribute with a datatype but no value.
  - getDataType
```
@Deprecated
public DataType getDataType()
```
    Deprecated. use getArrayType()
  - getArrayType
```
public ArrayType getArrayType()
```
    Get the data type of the Attribute value.
  - getEnumType
```
@Nullable
public EnumTypedef getEnumType()
```
    Get the EnumTypedef of the Attribute value, if DataType is an ENUM.
  - getLength
```
public int getLength()
```
    Get the length of the array of values
  - getName
```
public String getName()
```
    Get the Attribute name, same as the short name.
  - getNumericValue
```
@Nullable
public Number getNumericValue()
```
    Retrieve first numeric value. Equivalent to getNumericValue(0)
  - getNumericValue
```
@Nullable
public Number getNumericValue(int index)
```
    Retrieve a numeric value by index. If it's a String, it will try to parse it as a double.
    
    Parameters:
    
    index - the index into the value array.
    
    Returns:
    
    Number value[index], or null if its a non-parseable String or the index is out of range.
  - getShortName
```
public String getShortName()
```
    Get the Attribute name.
  - getStringValue
```
@Nullable
public String getStringValue()
```
    Retrieve first String value if this is a String valued attribute, else null.
  - getStringValue
```
@Nullable
public String getStringValue(int index)
```
    Retrieve ith String value; only call if isString() is true.
    
    Parameters:
    
    index - which index
    
    Returns:
    
    ith String value (if this is a String valued attribute and index in range), else null.
  - getValue
```
@Nullable
public Object getValue(int index)
```
    Get the value as an Object (String or Number).
    
    Parameters:
    
    index - index into value Array.
    
    Returns:
    
    ith value as an Object.
  - getValues
```
@Nullable
public Array getValues()
```
    Get the values as an ucar.ma2.Array.
  - getArrayValues
```
@Nullable
public Array<?> getArrayValues()
```
    Get the values as an ucar.array.Array.
  - isArray
```
public boolean isArray()
```
    True if value is an array (getLength() > 1)
  - isString
```
public boolean isString()
```
    True if value is of type String and not null.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toBuilder
```
public Attribute.Builder toBuilder()
```
    Turn into a mutable Builder. Can use toBuilder().build() to copy.
  - builder
```
public static Attribute.Builder builder()
```
    Create an Attribute builder.
  - builder
```
public static Attribute.Builder builder(String name)
```
    Create an Attribute builder with the given Attribute name.

Class Attribute

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Attribute

Attribute

Method Detail

fromParameter

toParameter

fromArray

fromArray

emptyValued

emptyValued

getDataType

getArrayType

getEnumType

getLength

getName

getNumericValue

getNumericValue

getShortName

getStringValue

getStringValue

getValue

getValues

getArrayValues

isArray

isString

toString

equals

hashCode

toBuilder

builder

builder