Packagecom.adobe.mediacore.metadata
Classpublic class Metadata
InheritanceMetadata Inheritance Object
Subclasses AdvertisingMetadata, ByteArrayMetadata, MetadataNode, NetworkConfiguration, VideoAnalyticsMetadata

Generic interface to access metadata associated with PSDK objects.



Public Methods
 MethodDefined By
  
containsKey(key:String):Boolean
Checks if the metadata contains the specified key.
Metadata
  
getByteArray(key:String):ByteArray
Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
Metadata
  
getMetadata(key:String):Metadata
Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
Metadata
  
getObject(key:String):Object
Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
Metadata
  
getValue(key:String):String
Returns the value associated with the specified key as string.
Metadata
  
isEmpty():Boolean
Checks if the metadata has any mapping defined.
Metadata
  
keySet():Vector.<String>
Returns a vector containing the strings used as keys in this metadata.
Metadata
  
setByteArray(key:String, byteArray:ByteArray):void
Stores a ByteArray value replacing any existing value for the given key.
Metadata
  
setMetadata(key:String, metadata:Metadata):void
Stores a Metadata value replacing any existing value for the given key.
Metadata
  
setObject(key:String, object:Object):void
Stores an object value replacing any existing value for the given key.
Metadata
  
setValue(key:String, value:String):void
Stores a String value into this metadata, replacing any existing value for the given key.
Metadata
  
toString():String
Returns the string representation of the specified object.
Metadata
Method Detail
containsKey()method
public final function containsKey(key:String):Boolean

Checks if the metadata contains the specified key.

Parameters

key:String — the key to be looked for

Returns
Boolean — true if the key is found, false otherwise.
getByteArray()method 
public function getByteArray(key:String):ByteArray

Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.

Parameters

key:String — a string key.

Returns
ByteArray — a byte array object, null if the key is not found or null if the value stored at the specific node is not of byte array type.
getMetadata()method 
public function getMetadata(key:String):Metadata

Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.

Parameters

key:String — a string key.

Returns
Metadata — a metadata object, null if the key is not found or null if the value stored at the specific node is not of Metadata type.
getObject()method 
public function getObject(key:String):Object

Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.

Parameters

key:String — a string key.

Returns
Object — an object, null if the key is not found or null if the value stored at the specific node is not of object type.
getValue()method 
public final function getValue(key:String):String

Returns the value associated with the specified key as string. The provided key must not be null or empty, otherwise the method will throw an ArgumentError.

Parameters

key:String — a string key

Returns
String — a string or null if the key is not found.
isEmpty()method 
public function isEmpty():Boolean

Checks if the metadata has any mapping defined.

Returns
Boolean — true if there are no values in it, false otherwise.
keySet()method 
public function keySet():Vector.<String>

Returns a vector containing the strings used as keys in this metadata. If the metadata is empty, it will return an empty set. Removing an element from this vector will not remove it from the metadata object.

Returns
Vector.<String> — a vector of strings
setByteArray()method 
public function setByteArray(key:String, byteArray:ByteArray):void

Stores a ByteArray value replacing any existing value for the given key.

Parameters

key:String — a string key
 
byteArray:ByteArray — the byte array value to be stored.

setMetadata()method 
public function setMetadata(key:String, metadata:Metadata):void

Stores a Metadata value replacing any existing value for the given key.

Parameters

key:String — a string key
 
metadata:Metadata — the metadata value to be stored.

setObject()method 
public function setObject(key:String, object:Object):void

Stores an object value replacing any existing value for the given key.

Parameters

key:String — a string key
 
object:Object — the object to be stored.

setValue()method 
public function setValue(key:String, value:String):void

Stores a String value into this metadata, replacing any existing value for the given key. The provided key must not be null or empty, otherwise the method will throw an ArgumentError.

Parameters

key:String — a string key
 
value:String — the value to be stored.

toString()method 
public function toString():String

Returns the string representation of the specified object. As the values contained in the metadata object can be really large and also the structure of the metadata object can be really complex, this method will return a string containing only the first level keys.

Returns
String — a string representation of the metadata object.