org.mpxj

Class AbstractFieldContainer<T>

java.lang.Object

org.mpxj.AbstractFieldContainer<T>

Type Parameters:

T - container type

All Implemented Interfaces:

FieldContainer

Direct Known Subclasses:

ProjectProperties, Resource, ResourceAssignment, Task

public abstract class AbstractFieldContainer<T>
extends Object
implements FieldContainer

Implementation of common functionality for the FieldContainer interface.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFieldContainer(ProjectFile file) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addFieldListener(FieldListener listener) Add a listener to receive field events.
void	disableEvents() Disable events firing when fields are updated.
void	enableEvents() Enable events firing when fields are updated.
Object	get(FieldType field) Retrieve a field value.
Object	getCachedValue(FieldType field) Retrieve a field value.
ProjectFile	getParentFile() Accessor method allowing retrieval of ProjectFile reference.
void	removeFieldListener(FieldListener listener) Remove a listener.
void	set(FieldType field, Object value) Set a field value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFieldContainer

protected AbstractFieldContainer(ProjectFile file)

Constructor.

Parameters:

file - Parent file

Method Detail

disableEvents

public void disableEvents()

Disable events firing when fields are updated.

enableEvents

public void enableEvents()

Enable events firing when fields are updated. This is the default state.

set

public void set(FieldType field,
                Object value)

Description copied from interface: FieldContainer

Set a field value.

Specified by:

set in interface FieldContainer

Parameters:

field - field identifier

value - field value

get

public Object get(FieldType field)

Description copied from interface: FieldContainer

Retrieve a field value.

Specified by:

get in interface FieldContainer

Parameters:

field - field identifier

Returns:

field value

getCachedValue

public Object getCachedValue(FieldType field)

Description copied from interface: FieldContainer

Retrieve a field value. Use the cached value. Do not attempt to calculate a value if the cached value is null.

Specified by:

getCachedValue in interface FieldContainer

Parameters:

field - field identifier

Returns:

field value

addFieldListener

public void addFieldListener(FieldListener listener)

Description copied from interface: FieldContainer

Add a listener to receive field events.

Specified by:

addFieldListener in interface FieldContainer

Parameters:

listener - target listener

removeFieldListener

public void removeFieldListener(FieldListener listener)

Description copied from interface: FieldContainer

Remove a listener.

Specified by:

removeFieldListener in interface FieldContainer

Parameters:

listener - target listener

getParentFile

public final ProjectFile getParentFile()

Accessor method allowing retrieval of ProjectFile reference.

Returns:

reference to this the parent ProjectFile instance