net.officefloor.frame.spi.source

Interface SourceContext

All Superinterfaces:

SourceProperties

All Known Subinterfaces:

AdministratorSourceContext, GovernanceSourceContext, HttpSecuritySourceContext, ManagedObjectPoolSourceContext, ManagedObjectSourceContext<F>, OfficeFloorSourceContext, OfficeSourceContext, SectionSourceContext, SupplierSourceContext, TeamSourceContext, WoofApplicationExtensionServiceContext, WoofTemplateChangeContext, WoofTemplateExtensionChangeContext, WoofTemplateExtensionSourceContext, WorkSourceContext

All Known Implementing Classes:

AdministratorSourceContextImpl, ManagedObjectSourceContextImpl, OfficeFloorSourceContextImpl, OfficeSourceContextImpl, SectionSourceContextImpl, SourceContextImpl, SupplierSourceContextImpl, TeamSourceContextImpl, WoofTemplateChangeContextImpl, WoofTemplateExtensionChangeContextImpl, WorkSourceContextImpl

public interface SourceContext
extends SourceProperties

Generic context for a source.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
ClassLoader	getClassLoader() Obtains the ClassLoader.
InputStream	getOptionalResource(String location) Attempts to obtain the resource at the specified location.
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.

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

getProperties, getProperty, getProperty, getPropertyNames

Method Detail

isLoadingType

boolean isLoadingType()

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.

Returns:

true if loading as a type.

loadOptionalClass

Class<?> loadOptionalClass(String name)

Attempts to load the specified Class.

Parameters:

name - Name of the Class.

Returns:

Class or null if the Class can not be found.

loadClass

Class<?> loadClass(String name)
            throws UnknownClassError

Loads the Class.

Parameters:

name - Name of the Class.

Returns:

Class.

Throws:

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

getOptionalResource

InputStream getOptionalResource(String location)

Attempts to obtain the resource at the specified location.

Parameters:

location - Location of the resource.

Returns:

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

getResource

InputStream getResource(String location)
                 throws UnknownResourceError

Obtains the resource.

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.

getClassLoader

ClassLoader getClassLoader()

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.

Returns:

ClassLoader.