com.sage.orion.sdata.servlet.accpac
Class JiBXConfigurationAbstractResource

java.lang.Object
  com.sage.orion.sdata.servlet.accpac.JiBXConfigurationAbstractResource

All Implemented Interfaces:

JiBXConfigurationResource

Direct Known Subclasses:

LookupField, ReferencedKeyField, ReferencedResource

public abstract class JiBXConfigurationAbstractResource
extends java.lang.Object
implements JiBXConfigurationResource

The JiBXConfigurationAbstractResource abstract class provides an abstract base class for the various classes that are part of the configuration system.

• Use ensureStillBuilding() to confirm that the object is still in building mode
• Use endBuilding() to signal the end of building
• Implement onEndBuilding() to perform any end-of-building actions
• Use addConfigurationError(String) to add any errors to the collection

Constructor Summary

JiBXConfigurationAbstractResource()

Method Summary

protected void	addConfigurationError(java.lang.String error) adds the given error to the collection of configuration errors
protected void	endBuilding() change from building mode into querying mode.
protected void	ensureStillBuilding() ensure that the objects is still in building mode, throwing an exception if not.
java.util.Collection<java.lang.String>	getConfigurationErrors() gets a list of the configuration errors that occurred during building.
protected abstract void	onEndBuilding() This will be called at the end of the building phase.

Methods inherited from class java.lang.Object

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

Constructor Detail

JiBXConfigurationAbstractResource

public JiBXConfigurationAbstractResource()

Method Detail

getConfigurationErrors

public java.util.Collection<java.lang.String> getConfigurationErrors()

gets a list of the configuration errors that occurred during building.

Specified by:

getConfigurationErrors in interface JiBXConfigurationResource

Returns:

a non-null unmodifiable collection of errors that occurred during building

onEndBuilding

protected abstract void onEndBuilding()

This will be called at the end of the building phase. The subclass must perform any required actions at that time, such as sealing lists, checking configurations, etc. It may call addConfigurationError(java.lang.String) during this call.

addConfigurationError

protected void addConfigurationError(java.lang.String error)

adds the given error to the collection of configuration errors

Parameters:

error - the error to add. This will only be added if it is not null.

ensureStillBuilding

protected void ensureStillBuilding()
                            throws java.lang.IllegalStateException

ensure that the objects is still in building mode, throwing an exception if not.

Throws:

java.lang.IllegalStateException - if not in building mode

endBuilding

protected void endBuilding()

change from building mode into querying mode. The subclass may call this at any suitable time. In addition this superclass will do so at suitable times, such as on calls to getConfigurationErrors().