org.apache.polygene.bootstrap

Interface LayerAssembly

public interface LayerAssembly

Fluid API for declaring a layer in an application. This is obtained by calling ApplicationAssembly.layer(String).

Method Summary

Modifier and Type	Method and Description
ApplicationAssembly	application()
EntityDeclaration	entities(Predicate<? super EntityAssembly> specification) Given a Specification for EntityAssembly's, returns a EntityDeclaration that can be used to work with all of the assemblies in this Layer matched by the specification.
ImportedServiceDeclaration	importedServices(Predicate<? super ImportedServiceAssembly> specification) Given a Specification for ImportedServiceAssembly's, returns a ImportedServiceDeclaration that can be used to work with all of the assemblies in this Layer matched by the specification.
ModuleAssembly	module(String name) Get an assembly for a particular Module.
String	name()
ObjectDeclaration	objects(Predicate<? super ObjectAssembly> specification) Given a Specification for ObjectAssembly's, returns a ObjectDeclaration that can be used to work with all of the assemblies in this Layer matched by the specification.
ServiceDeclaration	services(Predicate<? super ServiceAssembly> specification) Given a Specification for ServiceAssembly's, returns a ServiceDeclaration that can be used to work with all of the assemblies in this Layer matched by the specification.
LayerAssembly	setMetaInfo(Object info) Set metadata for the Layer.
LayerAssembly	setName(String name) Sets the name of the Layer being assembled.
TransientDeclaration	transients(Predicate<? super TransientAssembly> specification) Given a Specification for TransientAssembly's, returns a TransientDeclaration that can be used to work with all of the assemblies in this Layer matched by the specification.
LayerAssembly	uses(LayerAssembly... layerAssembly) Declaration of which other Layers that this Layer is able to use.
ValueDeclaration	values(Predicate<? super ValueAssembly> specification) Given a Specification for ValueAssembly's, returns a ValueDeclaration that can be used to work with all of the assemblies in this Layer matched by the specification.
<ThrowableType extends Throwable> void	visit(AssemblyVisitor<ThrowableType> visitor) Deprecated. New mechanism is considered, using Java 8 Stream API.
LayerAssembly	withActivators(Class<? extends Activator<Layer>>... activators) Set the layer activators.

Method Detail

module

ModuleAssembly module(String name)

Get an assembly for a particular Module. If this is called many times with the same name, then the same module is affected.

Parameters:

name - The name of the Module to retrieve or create.

Returns:

The ModuleAssembly for the Module.

application

ApplicationAssembly application()

Returns:

the ApplicationAssembly that this LayerAssembly belongs to.

name

String name()

Returns:

the name of the Layer that is being assembled.

setName

LayerAssembly setName(String name)

Sets the name of the Layer being assembled. By convention, a Layer should include the word "Layer" as the suffix, e.g "DomainLayer", so tooling can use camel-case detection and present the name and not require it to explicitly say that it is a layer.

Parameters:

name - The name that the Layer should have.

Returns:

this LayerAssembly instance to support fluent APIs

setMetaInfo

LayerAssembly setMetaInfo(Object info)

Set metadata for the Layer. Any arbitrary object can be attached as metainfo on a Layer that is available in runtime, by calling MetaInfoHolder.metaInfo(Class). Multiple registrations of the same type is not possible, and the lookup will search registered meta-info objects against the lookup type, prioritizing interfaces over classes and the most sub-typed nterface first.

Parameters:

info - The meta-info type to be looked up. Typically a type that is explicitly used for meta-info.

Returns:

this LayerAssembly instance to support fluent APIs

uses

LayerAssembly uses(LayerAssembly... layerAssembly)

Declaration of which other Layers that this Layer is able to use. This is how architecture reinforcement works. Any composites that are declared Visibility.application in a "used" layer can be reached from this Layer.

Parameters:

layerAssembly - The Layer(s) that this Layer can reach/see.

Returns:

this LayerAssembly instance to support fluent APIs

withActivators

LayerAssembly withActivators(Class<? extends Activator<Layer>>... activators)

Set the layer activators. Activators are executed in order around the Layer activation and passivation.

Parameters:

activators - the layer activators

Returns:

the assembly

visit

@Deprecated
<ThrowableType extends Throwable> void visit(AssemblyVisitor<ThrowableType> visitor)
                                                  throws ThrowableType extends Throwable

Deprecated. New mechanism is considered, using Java 8 Stream API.

The visitor pattern to inspect the entire pre-instantiated model.

Type Parameters:

ThrowableType - The exceptions that may be thrown.

Parameters:

visitor - The visitor to be called.

Throws:

ThrowableType - when there is an underlying problem in the model.

ThrowableType extends Throwable

entities

EntityDeclaration entities(Predicate<? super EntityAssembly> specification)

Given a Specification for EntityAssembly's, returns a EntityDeclaration that can be used to work with all of the assemblies in this Layer matched by the specification.

Parameters:

specification - The Specification that specifies the EntityComposite types of interest.

Returns:

An EntityDeclaration for the specified EntityComposite types.

services

ServiceDeclaration services(Predicate<? super ServiceAssembly> specification)

Given a Specification for ServiceAssembly's, returns a ServiceDeclaration that can be used to work with all of the assemblies in this Layer matched by the specification.

Parameters:

specification - The Specification that specifies the ServiceComposite types of interest.

Returns:

An ServiceDeclaration for the specified ServiceComposite types.

transients

TransientDeclaration transients(Predicate<? super TransientAssembly> specification)

Given a Specification for TransientAssembly's, returns a TransientDeclaration that can be used to work with all of the assemblies in this Layer matched by the specification.

Parameters:

specification - The Specification that specifies the TransientComposite types of interest.

Returns:

An TransientDeclaration for the specified TransientComposite types.

values

ValueDeclaration values(Predicate<? super ValueAssembly> specification)

Given a Specification for ValueAssembly's, returns a ValueDeclaration that can be used to work with all of the assemblies in this Layer matched by the specification.

Parameters:

specification - The Specification that specifies the ValueComposite types of interest.

Returns:

An ValueDeclaration for the specified ValueComposite types.

objects

ObjectDeclaration objects(Predicate<? super ObjectAssembly> specification)

Given a Specification for ObjectAssembly's, returns a ObjectDeclaration that can be used to work with all of the assemblies in this Layer matched by the specification.

Parameters:

specification - The Specification that specifies the Object types of interest.

Returns:

An ObjectDeclaration for the specified Object types.

importedServices

ImportedServiceDeclaration importedServices(Predicate<? super ImportedServiceAssembly> specification)

Given a Specification for ImportedServiceAssembly's, returns a ImportedServiceDeclaration that can be used to work with all of the assemblies in this Layer matched by the specification.

Parameters:

specification - The Specification that specifies the Imported Service types of interest.

Returns:

An ImportedServiceDeclaration for the specified Imported Service types.