IXmpLangAlt Interface
An XMP language alternative collection.
Declaration
public interface IXmpLangAlt extends Iterable<XmpProperty>Remarks
Refer to the following help topic for additional information: Manage PDF Document Properties and XMP Metadata.
Implements
Methods
add(String language, String text) Method
Adds a language-specific text value.
Declaration
public abstract IXmpLangAlt add(String language, String text)Parameters
| Name | Type | Description |
|---|---|---|
| language | String | The language code. |
| text | String | The text value. |
Returns
| Type | Description |
|---|---|
IXmpLangAlt |
The updated language alternative collection. |
clear() Method
Clears all language-specific text values.
Declaration
public abstract IXmpLangAlt clear()Returns
| Type | Description |
|---|---|
IXmpLangAlt |
The updated language alternative collection. |
containsDefault() Method
Returns whether the collection contains a default text value.
Declaration
public abstract boolean containsDefault()Returns
| Type | Description |
|---|---|
| boolean |
|
containsLanguage(String language) Method
Returns whether the collection contains a text value for the specified language.
Declaration
public abstract boolean containsLanguage(String language)Parameters
| Name | Type | Description |
|---|---|---|
| language | String | The language code. |
Returns
| Type | Description |
|---|---|
| boolean |
|
getDefault() Method
Returns the default text value.
Declaration
public abstract String getDefault()Returns
| Type | Description |
|---|---|
| String | The default text value. |
getValue(String language) Method
Returns the text value for the specified language.
Declaration
public abstract String getValue(String language)Parameters
| Name | Type | Description |
|---|---|---|
| language | String | The language code. |
Returns
| Type | Description |
|---|---|
| String | The text value for the specified language. |
iterator() Method
Returns an iterator for language-specific text values.
Declaration
public abstract Iterator<XmpProperty> iterator()Returns
| Type | Description |
|---|---|
| java.util.Iterator<XmpProperty> | An iterator for language-specific text values. |
remove(String language) Method
Removes the text value for the specified language.
Declaration
public abstract void remove(String language)Parameters
| Name | Type | Description |
|---|---|---|
| language | String | The language code. |
removeDefault() Method
Removes the default text value.
Declaration
public abstract void removeDefault()setDefault(String text) Method
Sets the default text value.
Declaration
public abstract void setDefault(String text)Parameters
| Name | Type | Description |
|---|---|---|
| text | String | The default text value. |
size() Method
Returns the number of language-specific text values.
Declaration
public abstract int size()Returns
| Type | Description |
|---|---|
| int | The number of language-specific text values. |
toString() Method
Returns the string value.
Declaration
public abstract String toString()Returns
| Type | Description |
|---|---|
| String | The string value. |
tryGetValue(String language, String[] text, Runnable text_sync) Method
Returns whether the collection contains a text value for the specified language.
Declaration
public abstract boolean tryGetValue(String language, String[] text, Runnable text_sync)Parameters
| Name | Type | Description |
|---|---|---|
| language | String | The language code. |
| text | java.lang.String[] | The text value for the specified language. |
| text_sync | Runnable | The synchronization callback for the text value. |
Returns
| Type | Description |
|---|---|
| boolean |
|