com.box.sdk

Class Metadata

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/

Constructor Summary

Constructors

Constructor and Description
Metadata() Creates an empty metadata.
Metadata(Metadata other) Creates a copy of another metadata.

Method Summary

Modifier and Type	Method and Description
Metadata	add(String path, String value) Adds a new metdata value.
String	get(String path) Returns a value.
String	getID() Returns the 36 character UUID to identify the metadata object.
String	getParentID() Returns the parent object ID (typically the file ID).
String	getPatch() Returns the JSON patch string with all operations.
String	getTypeName() Returns the metadata type.
Metadata	remove(String path) Removes an existing metadata value.
Metadata	replace(String path, String value) Replaces an existing metdata 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

Constructor Detail

Metadata

public Metadata()

Creates an empty metadata.

Metadata

public Metadata(Metadata other)

Creates a copy of another metadata.

Parameters:

other - the other metadata object to copy.

Method Detail

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.

add

public Metadata add(String path,
                    String value)

Adds a new metdata 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,
                        String value)

Replaces an existing metdata value.

Parameters:

path - the path that designates the key. Must be prefixed with a "/".

value - the value.

Returns:

this 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.

get

public String get(String path)

Returns a value.

Parameters:

path - the path that designates the key. Must be prefixed with a "/".

Returns:

the metadata property value.

getPatch

public String getPatch()

Returns the JSON patch string with all operations.

Returns:

the JSON patch string.

toString

public String toString()

Returns the JSON representation of this metadata.

Overrides:

toString in class Object

Returns:

the JSON representation of this metadata.