org.mpxj

Class CustomFieldContainer

java.lang.Object

org.mpxj.CustomFieldContainer

All Implemented Interfaces:

Iterable<CustomField>

public class CustomFieldContainer
extends Object
implements Iterable<CustomField>

Container holding configuration details for all custom fields.

Constructor Summary

Constructors

Constructor and Description
CustomFieldContainer()

Method Summary

Modifier and Type	Method and Description
CustomField	add(FieldType field) Add a new custom field.
void	deregisterValue(CustomFieldValueItem item) Remove a value from the custom field value index.
CustomField	get(FieldType field) Retrieve configuration details for a given field.
List<CustomField>	getCustomFieldsByFieldTypeClass(FieldTypeClass typeClass) Retrieve a list of custom fields by type class.
CustomFieldValueItem	getCustomFieldValueItemByGuid(UUID guid) Retrieve a custom field value item by its guid.
CustomFieldValueItem	getCustomFieldValueItemByUniqueID(int uniqueID) Retrieve a custom field value item by its unique ID.
FieldType	getFieldTypeByAlias(FieldTypeClass typeClass, String alias) Retrieve a field type from a particular entity using its alias.
CustomField	getOrCreate(FieldType field) Retrieve configuration details for a given field, create a new CustomField entry if one does not exist.
Iterator<CustomField>	iterator()
void	registerValue(CustomFieldValueItem item) Add a value to the custom field value index.
void	remove(FieldType field) Remove a custom field.
int	size() Return the number of custom fields.
Stream<CustomField>	stream() Return a stream of CustomField instances.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CustomFieldContainer

public CustomFieldContainer()

Method Detail

get

public CustomField get(FieldType field)

Retrieve configuration details for a given field. Return null if the field has not been configured.

Parameters:

field - target field type

Returns:

field configuration, or null if not configured

getOrCreate

public CustomField getOrCreate(FieldType field)

Retrieve configuration details for a given field, create a new CustomField entry if one does not exist.

Parameters:

field - required field

Returns:

configuration detail

add

public CustomField add(FieldType field)

Add a new custom field. Overwrite any previous custom field definition.

Parameters:

field - field type

Returns:

new CustomField instance

remove

public void remove(FieldType field)

Remove a custom field.

Parameters:

field - field type to remove

getFieldTypeByAlias

public FieldType getFieldTypeByAlias(FieldTypeClass typeClass,
                                     String alias)

Retrieve a field type from a particular entity using its alias.

Parameters:

typeClass - the type of entity we are interested in

alias - the alias

Returns:

the field type referred to be the alias, or null if not found

getCustomFieldsByFieldTypeClass

public List<CustomField> getCustomFieldsByFieldTypeClass(FieldTypeClass typeClass)

Retrieve a list of custom fields by type class.

Parameters:

typeClass - required type class

Returns:

list of CustomField instances

size

public int size()

Return the number of custom fields.

Returns:

number of custom fields

iterator

public Iterator<CustomField> iterator()

Specified by:

iterator in interface Iterable<CustomField>

getCustomFieldValueItemByUniqueID

public CustomFieldValueItem getCustomFieldValueItemByUniqueID(int uniqueID)

Retrieve a custom field value item by its unique ID.

Parameters:

uniqueID - custom field value unique ID

Returns:

custom field value item

getCustomFieldValueItemByGuid

public CustomFieldValueItem getCustomFieldValueItemByGuid(UUID guid)

Retrieve a custom field value item by its guid.

Parameters:

guid - custom field value guid

Returns:

custom field value item

registerValue

public void registerValue(CustomFieldValueItem item)

Add a value to the custom field value index.

Parameters:

item - custom field value item

deregisterValue

public void deregisterValue(CustomFieldValueItem item)

Remove a value from the custom field value index.

Parameters:

item - custom field value item

stream

public Stream<CustomField> stream()

Return a stream of CustomField instances.

Returns:

Stream instance