IXmpArray<T> Interface
Defines an XMP array.
Declaration
public interface IXmpArray<T> extends Iterable<T>Type Parameters
| Name | Description |
|---|---|
| T | The XMP array item type. |
Remarks
Refer to the following help topic for additional information: Manage PDF Document Properties and XMP Metadata.
Implements
Methods
add(String value) Method
Adds a string value to the XMP array.
Declaration
public abstract T add(String value)Parameters
| Name | Type | Description |
|---|---|---|
| value | String | The string value to add. |
Returns
| Type | Description |
|---|---|
| T | The added XMP array item. |
add(T value) Method
Adds an item to the XMP array.
Declaration
public abstract void add(T value)Parameters
| Name | Type | Description |
|---|---|---|
| value | T | The XMP array item to add. |
addRange(Iterable<String> values) Method
Adds string values to the XMP array.
Declaration
public abstract void addRange(Iterable<String> values)Parameters
| Name | Type | Description |
|---|---|---|
| values | java.lang.Iterable<java.lang.String> | The string values to add. |
clear() Method
Clears all items from the XMP array.
Declaration
public abstract void clear()get(int index) Method
Returns the XMP array item at the specified index.
Declaration
public abstract T get(int index)Parameters
| Name | Type | Description |
|---|---|---|
| index | int | The zero-based item index. |
Returns
| Type | Description |
|---|---|
| T | The XMP array item at the specified index. |
getArrayType() Method
Returns the XMP array type.
Declaration
public abstract XmpArrayType getArrayType()Returns
| Type | Description |
|---|---|
| XmpArrayType | The XMP array type. |
remove(String value) Method
Removes the specified string value from the XMP array.
Declaration
public abstract boolean remove(String value)Parameters
| Name | Type | Description |
|---|---|---|
| value | String | The string value to remove. |
Returns
| Type | Description |
|---|---|
| boolean |
|
remove(T item) Method
Removes the specified item from the XMP array.
Declaration
public abstract boolean remove(T item)Parameters
| Name | Type | Description |
|---|---|---|
| item | T | The XMP array item to remove. |
Returns
| Type | Description |
|---|---|
| boolean |
|
removeAt(int index) Method
Removes the XMP array item at the specified index.
Declaration
public abstract void removeAt(int index)Parameters
| Name | Type | Description |
|---|---|---|
| index | int | The zero-based item index. |
size() Method
Returns the number of items in the XMP array.
Declaration
public abstract int size()Returns
| Type | Description |
|---|---|
| int | The number of items in the XMP array. |
toString() Method
Returns the string value.
Declaration
public abstract String toString()Returns
| Type | Description |
|---|---|
| String | The string value. |