public class

PropertiesSet

extends Object
java.lang.Object
   ↳ xades4j.utils.PropertiesSet<T>

Class Overview

A generic bag of properties used to store properties that apply to a specific target (data object descriptions, signature properties collector, signed data objects). The properties are organized by type (class).

Summary

Public Constructors
PropertiesSet(int initialNPropTypes)
Initializes the property bag with the given initial diferent property types.
Public Methods
void add(T prop)
Adds a property to the bag.
Collection<T> getProperties()
Gets the properties in the bag.
boolean isEmpty()
Indicates whether the bag has any properties.
void put(T prop)
Puts a property in the bag.
void remove(T prop)
Removes a property from the bag.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PropertiesSet (int initialNPropTypes)

Initializes the property bag with the given initial diferent property types.

Parameters
initialNPropTypes the initial number of different property types.

Public Methods

public void add (T prop)

Adds a property to the bag. The add operation allows multiple properties of the same type but not repeated instances.

Parameters
prop the property
Throws
NullPointerException if prop is null
PropertyTargetException if the given property (instance) is already present in the bag

public Collection<T> getProperties ()

Gets the properties in the bag.

Returns
  • un unmodifiable collection of properties

public boolean isEmpty ()

Indicates whether the bag has any properties.

Returns
  • true if the bag has no properties

public void put (T prop)

Puts a property in the bag. The put operation doesn't allow repeated property types. If a property of this type was previously added an exception is thrown.

Parameters
prop the property
Throws
NullPointerException if prop is null
PropertyTargetException if a property of this type was previously added

public void remove (T prop)

Removes a property from the bag.

Parameters
prop the property to be removed
Throws
NullPointerException if the property is null
IllegalStateException if the property is not present