Metadata (Box Java SDK)

Object
- Metadata

```
public class Metadata
extends Object
```
The Metadata class represents one type instance of Box metadata.
Learn more about Box metadata: https://developers.box.com/metadata-api/

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLASSIFICATION_KEY` Classification key path.
`static String`	`CLASSIFICATION_TEMPLATE_KEY` Specifies the classification template key.
`static int`	`DEFAULT_LIMIT` The default limit of entries per response.
`static String`	`DEFAULT_METADATA_TYPE` Specifies the name of the default "properties" metadata template.
`static String`	`ENTERPRISE_METADATA_SCOPE` Specifies the "enterprise" metadata scope.
`static URLTemplate`	`GET_ALL_METADATA_URL_TEMPLATE` URL template for all metadata associated with item.
`static String`	`GLOBAL_METADATA_SCOPE` Specifies the "global" metadata scope.

Constructor Summary

Constructors
Constructor and Description
`Metadata()` Creates an empty metadata.
`Metadata(JsonObject values)` Creates a new metadata.
`Metadata(Metadata other)` Creates a copy of another metadata.
`Metadata(String scope, String template)` Creates a new metadata with the specified scope and template.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Metadata`	`add(String path, double value)` Adds a new metadata value.
`Metadata`	`add(String path, List<String> values)` Adds a new metadata value of array type.
`Metadata`	`add(String path, String value)` Adds a new metadata value.
`static Iterable<Metadata>`	`getAllMetadata(BoxItem item, String... fields)` Used to retrieve all metadata associated with the item.
`Date`	`getDate(String path)` Get a value from a date metadata field.
`double`	`getDouble(String path)` Get a value from a double metadata field.
`String`	`getID()` Returns the 36 character UUID to identify the metadata object.
`List<String>`	`getMultiSelect(String path)` Get a value from a multiselect metadata field.
`JsonArray`	`getOperations()` Returns an array of operations on metadata.
`String`	`getParentID()` Returns the parent object ID (typically the file ID).
`String`	`getPatch()` Returns the JSON patch string with all operations.
`List<String>`	`getPropertyPaths()` Returns a list of metadata property paths.
`String`	`getScope()` Returns the scope.
`String`	`getString(String path)` Get a value from a string or enum metadata field.
`String`	`getTemplateName()` Returns the template name.
`String`	`getTypeName()` Returns the metadata type.
`JsonValue`	`getValue(String path)` Returns a value, regardless of type.
`Metadata`	`remove(String path)` Removes an existing metadata value.
`Metadata`	`replace(String path, double value)` Replaces an existing metadata value.
`Metadata`	`replace(String path, float value)` Replaces an existing metadata value.
`Metadata`	`replace(String path, List<String> values)` Replaces an existing metadata value of array type.
`Metadata`	`replace(String path, String value)` Replaces an existing metadata value.
`Metadata`	`test(String path, List<String> values)` Tests that a list of properties has the expected value.
`Metadata`	`test(String path, String value)` Tests that a property has the expected value.
`String`	`toString()` Returns the JSON representation of this metadata.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_METADATA_TYPE
```
public static final String DEFAULT_METADATA_TYPE
```
    Specifies the name of the default "properties" metadata template.
    
    See Also:
    
    Constant Field Values
  - GLOBAL_METADATA_SCOPE
```
public static final String GLOBAL_METADATA_SCOPE
```
    Specifies the "global" metadata scope.
    
    See Also:
    
    Constant Field Values
  - ENTERPRISE_METADATA_SCOPE
```
public static final String ENTERPRISE_METADATA_SCOPE
```
    Specifies the "enterprise" metadata scope.
    
    See Also:
    
    Constant Field Values
  - CLASSIFICATION_TEMPLATE_KEY
```
public static final String CLASSIFICATION_TEMPLATE_KEY
```
    Specifies the classification template key.
    
    See Also:
    
    Constant Field Values
  - CLASSIFICATION_KEY
```
public static final String CLASSIFICATION_KEY
```
    Classification key path.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LIMIT
```
public static final int DEFAULT_LIMIT
```
    The default limit of entries per response.
    
    See Also:
    
    Constant Field Values
  - GET_ALL_METADATA_URL_TEMPLATE
```
public static final URLTemplate GET_ALL_METADATA_URL_TEMPLATE
```
    URL template for all metadata associated with item.
- Constructor Detail
  - Metadata
```
public Metadata()
```
    Creates an empty metadata.
  - Metadata
```
public Metadata(JsonObject values)
```
    Creates a new metadata.
    
    Parameters:
    
    values - the initial metadata values.
  - Metadata
```
public Metadata(Metadata other)
```
    Creates a copy of another metadata.
    
    Parameters:
    
    other - the other metadata object to copy.
  - Metadata
```
public Metadata(String scope,
                String template)
```
    Creates a new metadata with the specified scope and template.
    
    Parameters:
    
    scope - the scope of the metadata.
    
    template - the template of the metadata.
- Method Detail
  - getAllMetadata
```
public static Iterable<Metadata> getAllMetadata(BoxItem item,
                                                String... fields)
```
    Used to retrieve all metadata associated with the item.
    
    Parameters:
    
    item - item to get metadata for.
    
    fields - the optional fields to retrieve.
    
    Returns:
    
    An iterable of metadata instances associated with the item.
  - getID
```
public String getID()
```
    Returns the 36 character UUID to identify the metadata object.
    
    Returns:
    
    the metadata ID.
  - getTypeName
```
public String getTypeName()
```
    Returns the metadata type.
    
    Returns:
    
    the metadata type.
  - getParentID
```
public String getParentID()
```
    Returns the parent object ID (typically the file ID).
    
    Returns:
    
    the parent object ID.
  - getScope
```
public String getScope()
```
    Returns the scope. Can throw NullPointerException is value if not present.
    
    Returns:
    
    the scope.
  - getTemplateName
```
public String getTemplateName()
```
    Returns the template name. Can throw NullPointerException is value if not present.
    
    Returns:
    
    the template name.
  - add
```
public Metadata add(String path,
                    String value)
```
    Adds a new metadata value.
    
    Parameters:
    
    path - the path that designates the key. Must be prefixed with a "/".
    
    value - the value.
    
    Returns:
    
    this metadata object.
  - add
```
public Metadata add(String path,
                    double value)
```
    Adds a new metadata value.
    
    Parameters:
    
    path - the path that designates the key. Must be prefixed with a "/".
    
    value - the value.
    
    Returns:
    
    this metadata object.
  - add
```
public Metadata add(String path,
                    List<String> values)
```
    Adds a new metadata value of array type.
    
    Parameters:
    
    path - the path to the field.
    
    values - the collection of values.
    
    Returns:
    
    the metadata object for chaining.
  - replace
```
public Metadata replace(String path,
                        String value)
```
    Replaces an existing metadata value.
    
    Parameters:
    
    path - the path that designates the key. Must be prefixed with a "/".
    
    value - the value.
    
    Returns:
    
    this metadata object.
  - replace
```
public Metadata replace(String path,
                        float value)
```
    Replaces an existing metadata value.
    
    Parameters:
    
    path - the path that designates the key. Must be prefixed with a "/".
    
    value - the value.
    
    Returns:
    
    this metadata object.
  - replace
```
public Metadata replace(String path,
                        double value)
```
    Replaces an existing metadata value.
    
    Parameters:
    
    path - the path that designates the key. Must be prefixed with a "/".
    
    value - the value.
    
    Returns:
    
    this metadata object.
  - replace
```
public Metadata replace(String path,
                        List<String> values)
```
    Replaces an existing metadata value of array type.
    
    Parameters:
    
    path - the path that designates the key. Must be prefixed with a "/".
    
    values - the collection of values.
    
    Returns:
    
    the metadata object.
  - remove
```
public Metadata remove(String path)
```
    Removes an existing metadata value.
    
    Parameters:
    
    path - the path that designates the key. Must be prefixed with a "/".
    
    Returns:
    
    this metadata object.
  - test
```
public Metadata test(String path,
                     String value)
```
    Tests that a property has the expected value.
    
    Parameters:
    
    path - the path that designates the key. Must be prefixed with a "/".
    
    value - the expected value.
    
    Returns:
    
    this metadata object.
  - test
```
public Metadata test(String path,
                     List<String> values)
```
    Tests that a list of properties has the expected value. The values passed in will have to be an exact match with no extra elements.
    
    Parameters:
    
    path - the path that designates the key. Must be prefixed with a "/".
    
    values - the list of expected values.
    
    Returns:
    
    this metadata object.
  - getValue
```
public JsonValue getValue(String path)
```
    Returns a value, regardless of type.
    
    Parameters:
    
    path - the path that designates the key. Must be prefixed with a "/".
    
    Returns:
    
    the metadata property value as an indeterminate JSON type.
  - getString
```
public String getString(String path)
```
    Get a value from a string or enum metadata field. Can throw NullPointerException is value if not present.
    
    Parameters:
    
    path - the key path in the metadata object. Must be prefixed with a "/".
    
    Returns:
    
    the metadata value as a string.
  - getDouble
```
public double getDouble(String path)
```
    Get a value from a double metadata field. Can throw NullPointerException is value if not present.
    
    Parameters:
    
    path - the key path in the metadata object. Must be prefixed with a "/".
    
    Returns:
    
    the metadata value as a floating point number.
  - getDate
```
public Date getDate(String path)
             throws ParseException
```
    Get a value from a date metadata field. Can throw NullPointerException is value if not present.
    
    Parameters:
    
    path - the key path in the metadata object. Must be prefixed with a "/".
    
    Returns:
    
    the metadata value as a Date.
    
    Throws:
    
    ParseException - when the value cannot be parsed as a valid date
  - getMultiSelect
```
public List<String> getMultiSelect(String path)
```
    Get a value from a multiselect metadata field.
    
    Parameters:
    
    path - the key path in the metadata object. Must be prefixed with a "/".
    
    Returns:
    
    the list of values set in the field.
  - getPropertyPaths
```
public List<String> getPropertyPaths()
```
    Returns a list of metadata property paths.
    
    Returns:
    
    the list of metdata property paths.
  - getPatch
```
public String getPatch()
```
    Returns the JSON patch string with all operations.
    
    Returns:
    
    the JSON patch string.
  - getOperations
```
public JsonArray getOperations()
```
    Returns an array of operations on metadata.
    
    Returns:
    
    a JSON array of operations.
  - toString
```
public String toString()
```
    Returns the JSON representation of this metadata.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the JSON representation of this metadata.

Class Metadata

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

DEFAULT_METADATA_TYPE

GLOBAL_METADATA_SCOPE

ENTERPRISE_METADATA_SCOPE

CLASSIFICATION_TEMPLATE_KEY

CLASSIFICATION_KEY

DEFAULT_LIMIT

GET_ALL_METADATA_URL_TEMPLATE

Constructor Detail

Metadata

Metadata

Metadata

Metadata

Method Detail

getAllMetadata

getID

getTypeName

getParentID

getScope

getTemplateName

add

add

add

replace

replace

replace

replace

remove

test

test

getValue

getString

getDouble

getDate

getMultiSelect

getPropertyPaths

getPatch

getOperations

toString