Top Description Fields Constructors Methods
org.apache.xmpbox.type

public Class ComplexPropertyContainer

extends Object
Class Inheritance
Imports
java.util.ArrayList, .Iterator, .List, java.util.stream.Collectors
Object representation for arrays content This Class could be used to define directly a property with more than one field (structure) and also schemas
Author
a183132

Field Summary

Modifier and TypeField and Description
private final List<AbstractField>
properties

Constructor Summary

AccessConstructor and Description
public
ComplexPropertyContainer()

Complex Property type constructor (namespaceURI is given)

Method Summary

Modifier and TypeMethod and Description
public void
addProperty(AbstractField
the property to add
obj)

Add a property to the current structure

public boolean

Returns:

True if property is present in this container
containsProperty(AbstractField
The property to check
property)

Check if a XMPFieldObject is in the complex property

public List<AbstractField>

Returns:

All Properties contained in this container, never null.
getAllProperties()

Return all children associated to this property

protected AbstractField

Returns:

the property wanted
getFirstEquivalentProperty(String
the localname of property wanted
localName, Class<? extends AbstractField>
the property type of property wanted
type)

Give the first property found in this container with type and localname expected

public List<AbstractField>

Returns:

All properties with local name which match with localName given, or null if there are none.
getPropertiesByLocalName(String
the local name wanted
localName)

Return all properties with this specified localName.

public boolean

Returns:

True if these properties are equal.
isSameProperty(AbstractField
First property
prop1, AbstractField
Second property
prop2)

Check if two properties are equal.

public void
removePropertiesByName(String
The name for which to remove all.
localName)

Remove all properties with a specified LocalName.

public void
removeProperty(AbstractField
The property to remove
property)

Remove a property

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

propertiesback to summary
private final List<AbstractField> properties

Constructor Detail

ComplexPropertyContainerback to summary
public ComplexPropertyContainer()

Complex Property type constructor (namespaceURI is given)

Method Detail

addPropertyback to summary
public void addProperty(AbstractField obj)

Add a property to the current structure

Parameters
obj:AbstractField

the property to add

containsPropertyback to summary
public boolean containsProperty(AbstractField property)

Check if a XMPFieldObject is in the complex property

Parameters
property:AbstractField

The property to check

Returns:boolean

True if property is present in this container

getAllPropertiesback to summary
public List<AbstractField> getAllProperties()

Return all children associated to this property

Returns:List<AbstractField>

All Properties contained in this container, never null.

getFirstEquivalentPropertyback to summary
protected AbstractField getFirstEquivalentProperty(String localName, Class<? extends AbstractField> type)

Give the first property found in this container with type and localname expected

Parameters
localName:String

the localname of property wanted

type:Class<? extends AbstractField>

the property type of property wanted

Returns:AbstractField

the property wanted

getPropertiesByLocalNameback to summary
public List<AbstractField> getPropertiesByLocalName(String localName)

Return all properties with this specified localName.

Parameters
localName:String

the local name wanted

Returns:List<AbstractField>

All properties with local name which match with localName given, or null if there are none.

isSamePropertyback to summary
public boolean isSameProperty(AbstractField prop1, AbstractField prop2)

Check if two properties are equal.

Parameters
prop1:AbstractField

First property

prop2:AbstractField

Second property

Returns:boolean

True if these properties are equal.

removePropertiesByNameback to summary
public void removePropertiesByName(String localName)

Remove all properties with a specified LocalName.

Parameters
localName:String

The name for which to remove all.

removePropertyback to summary
public void removeProperty(AbstractField property)

Remove a property

Parameters
property:AbstractField

The property to remove