org.qi4j.bootstrap
Interface EntityDeclaration


public interface EntityDeclaration

Fluent API for declaring entities. Instances of this API are acquired by calling ModuleAssembly.entities(Class[]).


Method Summary
 EntityDeclaration setMetaInfo(Object info)
          Set additional metainfo for this entity declaration.
 EntityDeclaration visibleIn(Visibility visibility)
          Set visibility for declared entities.
 EntityDeclaration withConcerns(Class<?>... concerns)
          Declare additional concerns for these entities.
 EntityDeclaration withMixins(Class<?>... mixins)
          Declare additional mixins for these entities.
 EntityDeclaration withRoles(Class<?>... roleInterfaces)
          Declare additional role interfaces for these declared interfaces.
 EntityDeclaration withSideEffects(Class<?>... sideEffects)
          Declare additional side-effects for these entitites.
 

Method Detail

setMetaInfo

EntityDeclaration setMetaInfo(Object info)
Set additional metainfo for this entity declaration.

Parameters:
info - metainfo that can be retrieved from the EntityDescriptor.
Returns:

visibleIn

EntityDeclaration visibleIn(Visibility visibility)
Set visibility for declared entities.

Parameters:
visibility -
Returns:

withConcerns

EntityDeclaration withConcerns(Class<?>... concerns)
Declare additional concerns for these entities.

Parameters:
concerns -
Returns:

withSideEffects

EntityDeclaration withSideEffects(Class<?>... sideEffects)
Declare additional side-effects for these entitites.

Parameters:
sideEffects -
Returns:

withMixins

EntityDeclaration withMixins(Class<?>... mixins)
Declare additional mixins for these entities.

This can be useful to override any default mixins from the entity interface.

Parameters:
mixins -
Returns:

withRoles

EntityDeclaration withRoles(Class<?>... roleInterfaces)
Declare additional role interfaces for these declared interfaces.

This can be useful to add roles that the entities should implement, but which you do not want to include in the entity interface itself.

Parameters:
roleInterfaces - list of role interfaces to add
Returns: