net.sf.mpxj

Class UserDefinedFieldContainer

java.lang.Object

net.sf.mpxj.UserDefinedFieldContainer

All Implemented Interfaces:

Iterable<UserDefinedField>, Collection<UserDefinedField>

public class UserDefinedFieldContainer
extends Object
implements Collection<UserDefinedField>

Manages the collection of user defined fields belonging to a project.

Constructor Summary

Constructors

Constructor and Description
UserDefinedFieldContainer(CustomFieldContainer customFields) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	add(UserDefinedField field)
boolean	addAll(Collection<? extends UserDefinedField> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
void	forEach(Consumer<? super UserDefinedField> action)
Collection<UserDefinedField>	getAssignmentFields() Retrieve a collection of resource assignment user defined fields.
UserDefinedField	getByUniqueID(Integer id) Retrieve a user defined field by its Unique ID.
UserDefinedField	getOrCreateAssignmentField(Integer id, Function<Integer,UserDefinedField> createFunction) Retrieve or create a user defined field by ID.
UserDefinedField	getOrCreateProjectField(Integer id, Function<Integer,UserDefinedField> createFunction) Retrieve or create a user defined field by ID.
UserDefinedField	getOrCreateResourceField(Integer id, Function<Integer,UserDefinedField> createFunction) Retrieve or create a user defined field by ID.
UserDefinedField	getOrCreateTaskField(Integer id, Function<Integer,UserDefinedField> createFunction) Retrieve or create a user defined field by ID.
Collection<UserDefinedField>	getProjectFields() Retrieve a collection of project user defined fields.
Collection<UserDefinedField>	getResourceFields() Retrieve a collection of resource user defined fields.
Collection<UserDefinedField>	getTaskFields() Retrieve a collection fo task user defined fields.
boolean	isEmpty()
Iterator<UserDefinedField>	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Spliterator<UserDefinedField>	spliterator()
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, stream

Constructor Detail

UserDefinedFieldContainer

public UserDefinedFieldContainer(CustomFieldContainer customFields)

Constructor.

Parameters:

customFields - custom fields container

Method Detail

iterator

public Iterator<UserDefinedField> iterator()

Specified by:

iterator in interface Iterable<UserDefinedField>

Specified by:

iterator in interface Collection<UserDefinedField>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<UserDefinedField>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<UserDefinedField>

add

public boolean add(UserDefinedField field)

Specified by:

add in interface Collection<UserDefinedField>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<UserDefinedField>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<UserDefinedField>

addAll

public boolean addAll(Collection<? extends UserDefinedField> c)

Specified by:

addAll in interface Collection<UserDefinedField>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<UserDefinedField>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<UserDefinedField>

clear

public void clear()

Specified by:

clear in interface Collection<UserDefinedField>

forEach

public void forEach(Consumer<? super UserDefinedField> action)

Specified by:

forEach in interface Iterable<UserDefinedField>

spliterator

public Spliterator<UserDefinedField> spliterator()

Specified by:

spliterator in interface Iterable<UserDefinedField>

Specified by:

spliterator in interface Collection<UserDefinedField>

size

public int size()

Specified by:

size in interface Collection<UserDefinedField>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<UserDefinedField>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<UserDefinedField>

getTaskFields

public Collection<UserDefinedField> getTaskFields()

Retrieve a collection fo task user defined fields.

Returns:

task user defined fields

getResourceFields

public Collection<UserDefinedField> getResourceFields()

Retrieve a collection of resource user defined fields.

Returns:

resource user defined fields

getAssignmentFields

public Collection<UserDefinedField> getAssignmentFields()

Retrieve a collection of resource assignment user defined fields.

Returns:

resource assignment user defined fields

getProjectFields

public Collection<UserDefinedField> getProjectFields()

Retrieve a collection of project user defined fields.

Returns:

project user defined fields

getOrCreateTaskField

public UserDefinedField getOrCreateTaskField(Integer id,
                                             Function<Integer,UserDefinedField> createFunction)

Retrieve or create a user defined field by ID.

Parameters:

id - field ID

createFunction - function to create a user defined field

Returns:

user defined field

getOrCreateResourceField

public UserDefinedField getOrCreateResourceField(Integer id,
                                                 Function<Integer,UserDefinedField> createFunction)

Retrieve or create a user defined field by ID.

Parameters:

id - field ID

createFunction - function to create a user defined field

Returns:

user defined field

getOrCreateAssignmentField

public UserDefinedField getOrCreateAssignmentField(Integer id,
                                                   Function<Integer,UserDefinedField> createFunction)

Retrieve or create a user defined field by ID.

Parameters:

id - field ID

createFunction - function to create a user defined field

Returns:

user defined field

getOrCreateProjectField

public UserDefinedField getOrCreateProjectField(Integer id,
                                                Function<Integer,UserDefinedField> createFunction)

Retrieve or create a user defined field by ID.

Parameters:

id - field ID

createFunction - function to create a user defined field

Returns:

user defined field

getByUniqueID

public UserDefinedField getByUniqueID(Integer id)

Retrieve a user defined field by its Unique ID.

Parameters:

id - entity Unique ID

Returns:

user defined field or null