Package org.apache.xmlgraphics.xmp
Class XMPArray
java.lang.Object
org.apache.xmlgraphics.xmp.XMPComplexValue
org.apache.xmlgraphics.xmp.XMPArray
- All Implemented Interfaces:
XMLizable
Represents an XMP array as defined by the XMP specification.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
Adds a language-dependent value to the array.void
Adds a new value to the arraygetLangValue
(String lang) Returns a language-dependent values (available for alternative arrays).Returns a normal Java object representing the value if it is available.int
getSize()
Returns the current number of values in the array.getStructure
(int idx) Returns the structure at a given position.getType()
getValue
(int idx) Returns the value at a given position.boolean
isEmpty()
Indicates whether the array is empty or not.boolean
Removes a value from the array.removeLangValue
(String lang) Removes a language-dependent value.Object[]
Converts the array to an object array.void
toSAX
(ContentHandler handler) Generates SAX events representing the object's state.toString()
-
Constructor Details
-
XMPArray
Main constructor- Parameters:
type
- the intended type of array
-
-
Method Details
-
getType
- Returns:
- the type of array
-
getValue
Returns the value at a given position.- Parameters:
idx
- the index of the requested value- Returns:
- the value at the given position
-
getStructure
Returns the structure at a given position. If the value is not a structure a ClassCastException is thrown.- Parameters:
idx
- the index of the requested value- Returns:
- the structure at the given position
-
getSimpleValue
Returns a normal Java object representing the value if it is available.- Specified by:
getSimpleValue
in classXMPComplexValue
- Returns:
- a simple object value or null if no such value can be returned (for example, because the value is an array and has multiple entries.
-
getLangValue
Returns a language-dependent values (available for alternative arrays).- Parameters:
lang
- the language ("x-default" for the default value)- Returns:
- the requested value
-
removeLangValue
Removes a language-dependent value.- Parameters:
lang
- the language ("x-default" for the default value)- Returns:
- the removed value (or null if no value was set)
-
add
Adds a new value to the array- Parameters:
value
- the value
-
add
Adds a language-dependent value to the array. Make sure not to add the same language twice.- Parameters:
value
- the valuelang
- the language ("x-default" for the default value)
-
add
-
remove
Removes a value from the array. If the value doesn't exist, nothing happens.- Parameters:
value
- the value to be removed- Returns:
- true if the value was removed, false if it wasn't found
-
getSize
public int getSize()Returns the current number of values in the array.- Returns:
- the current number of values in the array
-
isEmpty
public boolean isEmpty()Indicates whether the array is empty or not.- Returns:
- true if the array is empty
-
toObjectArray
Converts the array to an object array.- Returns:
- an object array of all values in the array
-
toSAX
Generates SAX events representing the object's state.- Parameters:
handler
- ContentHandler instance to send the SAX events to- Throws:
SAXException
- if there's a problem generating the SAX events
-
toString
-