Package net.officefloor.frame.impl.construct.source

Class SourceContextImpl

java.lang.Object

net.officefloor.frame.impl.construct.source.SourcePropertiesImpl

net.officefloor.frame.impl.construct.source.SourceContextImpl

All Implemented Interfaces:

ServiceContext, SourceContext, SourceProperties

Direct Known Subclasses:

ConfigurationSourceContextImpl, ExecutiveContextImpl, ExecutiveSourceContextImpl, ManagedFunctionSourceContextImpl, ManagedObjectPoolSourceContextImpl, ManagedObjectSourceContextImpl, SupplierSourceContextImpl, TeamSourceContextWrapper

public class SourceContextImpl
extends SourcePropertiesImpl
implements SourceContext, ServiceContext

SourceContext implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
SourceContextImpl(String sourceName, boolean isLoadingType, String[] profiles, ClassLoader classLoader, ClockFactory clockFactory, ResourceSource... resourceSources)	Initiate the raw SourceContext to seed other SourceContext instances.
SourceContextImpl(String sourceName, boolean isLoadingType, String[] additionalProfiles, SourceContext delegate, SourceProperties sourceProperties)	Initiate specific SourceContext with necessary SourceProperties.

Method Summary

Modifier and Type	Method	Description
ClassLoader	getClassLoader()	Obtains the ClassLoader.
<T> Clock<T>	getClock(Function<Long,T> translator)	Obtains the Clock.
Logger	getLogger()	Obtains the Logger.
String	getName()	Obtains the name of the item being sourced.
InputStream	getOptionalResource(String location)	Attempts to obtain the resource at the specified location.
List<String>	getProfiles()	Obtains the listing of active profiles.
InputStream	getResource(String location)	Obtains the resource.
boolean	isLoadingType()	Indicates if just loading as a type.
Class<?>	loadClass(String name)	Loads the Class.
Class<?>	loadOptionalClass(String name)	Attempts to load the specified Class.
<S, F extends ServiceFactory<S>> S	loadOptionalService(Class<F> serviceFactoryType)	Optionally loads a single service.
<S, F extends ServiceFactory<S>> Iterable<S>	loadOptionalServices(Class<F> serviceFactoryType)	Optionally loads multiple services.
<S, F extends ServiceFactory<S>> S	loadService(F serviceFactory)	Loads the specific service.
<S, F extends ServiceFactory<S>, D extends F> S	loadService(Class<F> serviceFactoryType, D defaultServiceFactory)	Loads a single service.
<S, F extends ServiceFactory<S>, D extends F> Iterable<S>	loadServices(Class<F> serviceFactoryType, D defaultServiceFactory)	Loads multiple services.

Methods inherited from class net.officefloor.frame.impl.construct.source.SourcePropertiesImpl

addProperty, getProperties, getProperty, getProperty, getPropertyNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.frame.api.source.SourceProperties

getProperties, getProperty, getProperty, getPropertyNames

Constructor Details

SourceContextImpl

public SourceContextImpl(String sourceName,
 boolean isLoadingType,
 String[] profiles,
 ClassLoader classLoader,
 ClockFactory clockFactory,
 ResourceSource... resourceSources)

Initiate the raw SourceContext to seed other SourceContext instances.

Parameters:

sourceName - Name of source.

isLoadingType - Indicates if loading type.

profiles - Active profiles.

classLoader - ClassLoader.

clockFactory - ClockFactory.

resourceSources - ResourceSource instances.

SourceContextImpl

public SourceContextImpl(String sourceName,
 boolean isLoadingType,
 String[] additionalProfiles,
 SourceContext delegate,
 SourceProperties sourceProperties)

Initiate specific SourceContext with necessary SourceProperties.

Parameters:

sourceName - Name of source.

isLoadingType - Indicates if loading type.

additionalProfiles - Additional profiles.

delegate - Delegate SourceContext.

sourceProperties - SourceProperties.

Method Details

getName

public String getName()

Description copied from interface: SourceContext

Obtains the name of the item being sourced.

Specified by:

getName in interface SourceContext

Returns:

Name of item being sourced.

isLoadingType

public boolean isLoadingType()

Description copied from interface: SourceContext

Indicates if just loading as a type.

When loading as a type the configuration provided is disregarded. This allows sources to know when to load singleton configuration that will take effect.

Whether this is true or false the resulting type should be the same.

Specified by:

isLoadingType in interface SourceContext

Returns:

true if loading as a type.

getProfiles

public List<String> getProfiles()

Description copied from interface: SourceContext

Obtains the listing of active profiles.

Specified by:

getProfiles in interface SourceContext

Returns:

Active profiles.

loadOptionalClass

public Class<?> loadOptionalClass(String name)

Description copied from interface: SourceContext

Attempts to load the specified Class.

Specified by:

loadOptionalClass in interface SourceContext

Parameters:

name - Name of the Class.

Returns:

Class or null if the Class can not be found.

loadClass

public Class<?> loadClass(String name)
                   throws UnknownClassError

Description copied from interface: SourceContext

Loads the Class.

Specified by:

loadClass in interface SourceContext

Parameters:

name - Name of the Class.

Returns:

Class.

Throws:

UnknownClassError - If Class is not available. Let this propagate as OfficeFloor will handle it.

getOptionalResource

public InputStream getOptionalResource(String location)

Description copied from interface: SourceContext

Attempts to obtain the resource at the specified location.

Specified by:

getOptionalResource in interface SourceContext

Parameters:

location - Location of the resource.

Returns:

InputStream to the contents of the resource or null if the resource can not be found.

getResource

public InputStream getResource(String location)
                        throws UnknownResourceError

Description copied from interface: SourceContext

Obtains the resource.

Specified by:

getResource in interface SourceContext

Parameters:

location - Location of the resource.

Returns:

InputStream to the contents of the resource.

Throws:

UnknownResourceError - If resource is not found. Let this propagate as OfficeFloor will handle it.

loadService

public <S,
F extends ServiceFactory<S>> S loadService(F serviceFactory)
                                              throws LoadServiceError

Description copied from interface: SourceContext

Loads the specific service.

Specified by:

loadService in interface SourceContext

Type Parameters:

S - Service type

F - ServiceFactory type to create service.

Parameters:

serviceFactory - ServiceFactory.

Returns:

Service.

Throws:

LoadServiceError - If fails to load the service.

loadService

public <S,
F extends ServiceFactory<S>,
D extends F>
S loadService(Class<F> serviceFactoryType,
 D defaultServiceFactory)
       throws UnknownServiceError,
LoadServiceError

Description copied from interface: SourceContext

Loads a single service.

Specified by:

loadService in interface SourceContext

Type Parameters:

S - Service type

F - ServiceFactory type to create service.

D - Default ServiceFactory type.

Parameters:

serviceFactoryType - Type of ServiceFactory.

defaultServiceFactory - Default ServiceFactory implementation. May be null to indicate no default service (one must be configured).

Returns:

Service.

Throws:

UnknownServiceError - If service is not configured and no default provided. Will also be thrown if more than one service is configured.

LoadServiceError - If fails to load the service.

loadOptionalService

public <S,
F extends ServiceFactory<S>> S loadOptionalService(Class<F> serviceFactoryType)
                                                      throws LoadServiceError

Description copied from interface: SourceContext

Optionally loads a single service.

Specified by:

loadOptionalService in interface SourceContext

Type Parameters:

S - Service type

F - ServiceFactory type to create service.

Parameters:

serviceFactoryType - Type of ServiceFactory.

Returns:

Service or null if no service configured.

Throws:

LoadServiceError - If fails to load the service or ServiceLoader finds more than one service configured.

loadServices

public <S,
F extends ServiceFactory<S>,
D extends F>
Iterable<S> loadServices(Class<F> serviceFactoryType,
 D defaultServiceFactory)
                  throws UnknownServiceError,
LoadServiceError

Description copied from interface: SourceContext

Loads multiple services.

Specified by:

loadServices in interface SourceContext

Type Parameters:

S - Service type

F - ServiceFactory type to create service.

D - Default ServiceFactory type.

Parameters:

serviceFactoryType - Type of ServiceFactory.

defaultServiceFactory - Default ServiceFactory implementation. May be null to indicate no default service.

Returns:

Iterable over the services. The Iterable may also throw LoadServiceError if fails to create next service.

Throws:

UnknownServiceError - If no services are configured and no default provided.

LoadServiceError - If fails to load a service.

loadOptionalServices

public <S,
F extends ServiceFactory<S>> Iterable<S> loadOptionalServices(Class<F> serviceFactoryType)
                                                                 throws LoadServiceError

Description copied from interface: SourceContext

Optionally loads multiple services.

Specified by:

loadOptionalServices in interface SourceContext

Type Parameters:

S - Service type

F - ServiceFactory type to create service.

Parameters:

serviceFactoryType - Type of ServiceFactory.

Returns:

Iterable over the services. May be no entries available. The Iterable may also throw LoadServiceError if fails to create next service.

Throws:

LoadServiceError - If fails to load a service.

getClock

public <T> Clock<T> getClock(Function<Long,T> translator)

Description copied from interface: SourceContext

Obtains the Clock.

Specified by:

getClock in interface SourceContext

Type Parameters:

T - Type of time.

Parameters:

translator - Translate the seconds since Epoch to "time" returned from the Clock.

Returns:

Clock.

getLogger

public Logger getLogger()

Description copied from interface: SourceContext

Obtains the Logger.

The Logger is named specific to the source. This is especially the case for re-use of Class within sources, as would not be able to differentiate.

Specified by:

getLogger in interface SourceContext

Returns:

Logger.

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: SourceContext

Obtains the ClassLoader.

This is only provided in specific cases where a ClassLoader is required (such as creating a Proxy). The other methods of this interface should be used in preference to the returned ClassLoader.

Specified by:

getClassLoader in interface SourceContext

Returns:

ClassLoader.