Package net.officefloor.compile.spi.administration.source.impl

Class AbstractAdministrationSource<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>

java.lang.Object

net.officefloor.compile.spi.administration.source.impl.AbstractAdministrationSource<E,F,G>

All Implemented Interfaces:

AdministrationSource<E,F,G>

Direct Known Subclasses:

ClassAdministrationSource, HttpAccessAdministrationSource

public abstract class AbstractAdministrationSource<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>
extends java.lang.Object
implements AdministrationSource<E,F,G>

Abstract AdministrationSource.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractAdministrationSource.Labeller	Provides the ability to label the Flow.
static interface	AbstractAdministrationSource.MetaDataContext<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>	Context for the AdministrationSource.init(AdministrationSourceContext).
static interface	AbstractAdministrationSource.SpecificationContext	Context for the getSpecification().

Constructor Summary

Constructors

Constructor	Description
AbstractAdministrationSource()

Method Summary

Modifier and Type	Method	Description
AdministrationSourceSpecification	getSpecification()	Obtains the specification for this.
AdministrationSourceMetaData<E,F,G>	init(AdministrationSourceContext context)	Initialises the AdministrationSource.
protected abstract void	loadMetaData(AbstractAdministrationSource.MetaDataContext<E,F,G> context)	Overridden to load meta-data.
protected abstract void	loadSpecification(AbstractAdministrationSource.SpecificationContext context)	Overridden to load specification.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAdministrationSource

public AbstractAdministrationSource()

Method Detail

getSpecification

public AdministrationSourceSpecification getSpecification()

Description copied from interface: AdministrationSource

Obtains the specification for this.

This will be called before any other methods, therefore this method must be able to return the specification immediately after a default constructor instantiation.

Specified by:

getSpecification in interface AdministrationSource<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>

Returns:

Specification of this.

loadSpecification

protected abstract void loadSpecification(AbstractAdministrationSource.SpecificationContext context)

Overridden to load specification.

Parameters:

context - Specifications.

init

public AdministrationSourceMetaData<E,F,G> init(AdministrationSourceContext context)
                                                     throws java.lang.Exception

Description copied from interface: AdministrationSource

Initialises the AdministrationSource.

Specified by:

init in interface AdministrationSource<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>

Parameters:

context - AdministrationSourceContext to initialise this instance of the AdministrationSource.

Returns:

Meta-data to describe this.

Throws:

java.lang.Exception - Should the AdministrationSource fail to configure itself from the input properties.

loadMetaData

protected abstract void loadMetaData(AbstractAdministrationSource.MetaDataContext<E,F,G> context)
                              throws java.lang.Exception

Overridden to load meta-data.

Parameters:

context - Meta-data.

Throws:

java.lang.Exception - If fails to load the meta-data.