com.asakusafw.operator

Class CompileEnvironment

java.lang.Object

com.asakusafw.operator.CompileEnvironment

public class CompileEnvironment
extends Object

Represents operator compiler environment.

Since:

0.9.0

Version:

0.10.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompileEnvironment.Support Represents kind of supported features in CompileEnvironment.

Constructor Summary

Constructors

Constructor and Description
CompileEnvironment(ProcessingEnvironment processingEnvironment, List<? extends OperatorDriver> operatorDrivers, List<? extends DataModelMirrorRepository> dataModelMirrors) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	emit(CompilationUnit unit, Element... originatingElements) Emits the target compilation unit onto suitable location.
DataModelMirror	findDataModel(ClassDescription typeName) Returns data-model mirror.
DataModelMirror	findDataModel(TypeMirror type) Returns data-model mirror.
DeclaredType	findDeclaredType(ClassDescription aClass) Returns the type mirror witch has the specified qualified name.
OperatorDriver	findDriver(TypeElement annotationType) Returns a registered operator driver related to the annotation type.
TypeElement	findTypeElement(ClassDescription aClass) Returns the type element which has the specified qualified name.
TypeMirror	getErasure(TypeMirror type) Returns the type erasure.
String	getMemberName(String token) Returns the normalized member name.
List<OperatorDriver>	getOperatorDrivers() Returns registered operator drivers.
ProcessingEnvironment	getProcessingEnvironment() Returns the current processing environment.
WarningAction	getWarningAction() Returns the warning action type.
boolean	isEnumConstantParameter() Returns whether or not the operators can accept enum constants as value parameter.
boolean	isFlowpartExternalIo() Returns whether external I/O declaration is available in flow-parts or not.
boolean	isForceGenerateImplementation() Returns whether always generates implementation classes or not.
boolean	isForceNormalizeMemberName() Returns whether or not the member names must be normalized.
boolean	isForceRegenerateResources() Returns whether always re-generates resources or not.
boolean	isResourceGenerated(ClassDescription key) Returns whether the target resources is generated or not.
boolean	isStrictOperatorParameterOrder() Returns whether the operator method parameter must be strict ordered or not.
boolean	isStrictOptionalOutputConnectivity() Returns whether or not the operator outputs must not be opened even if they are optional.
boolean	isUnboundProjection() Returns whether or not the operators can accept unbound projective models.
static CompileEnvironment	newInstance(ProcessingEnvironment processingEnvironment, ClassLoader serviceLoader, CompileEnvironment.Support... features) Creates a new instance.
static CompileEnvironment	newInstance(ProcessingEnvironment processingEnvironment, CompileEnvironment.Support... features) Creates a new instance.
void	setResourceGenerated(ClassDescription key) Sets the target resources is generated.
CompileEnvironment	withEnumConstantParameter(boolean newValue) Sets whether or not the operators can accept enum constants as value parameter.
CompileEnvironment	withFlowpartExternalIo(boolean newValue) Sets whether external I/O declarations are available in flow-parts or not.
CompileEnvironment	withForceGenerateImplementation(boolean newValue) Sets whether always generates implementation classes or not.
CompileEnvironment	withForceNormalizeMemberName(boolean newValue) Sets whether or not the member names must be normalized.
CompileEnvironment	withForceRegenerateResources(boolean newValue) Sets whether always re-generates resources.
CompileEnvironment	withStrictOperatorParameterOrder(boolean newValue) Sets whether the operator method parameter must be strict ordered or not.
CompileEnvironment	withStrictOptionalOutputConnectivity(boolean newValue) Sets whether or not the operator outputs must not be opened even if they are optional.
CompileEnvironment	withUnboundProjection(boolean newValue) Sets whether or not the operators can accept unbound projective models.
CompileEnvironment	withWarningAction(WarningAction newValue) Sets the warning action type.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompileEnvironment

public CompileEnvironment(ProcessingEnvironment processingEnvironment,
                          List<? extends OperatorDriver> operatorDrivers,
                          List<? extends DataModelMirrorRepository> dataModelMirrors)

Creates a new instance.

Parameters:

processingEnvironment - current annotation processing environment

operatorDrivers - supported operator drivers

dataModelMirrors - supported data model mirror repositories

Throws:

IllegalArgumentException - if some parameters were null

See Also:

newInstance(ProcessingEnvironment, ClassLoader, Support...)

Method Detail

newInstance

public static CompileEnvironment newInstance(ProcessingEnvironment processingEnvironment,
                                             CompileEnvironment.Support... features)

Creates a new instance.

Parameters:

processingEnvironment - current annotation processing environment.

features - list of supported features

Returns:

the created instance

Throws:

IllegalArgumentException - if some parameters were null

newInstance

public static CompileEnvironment newInstance(ProcessingEnvironment processingEnvironment,
                                             ClassLoader serviceLoader,
                                             CompileEnvironment.Support... features)

Creates a new instance.

Parameters:

processingEnvironment - current annotation processing environment.

serviceLoader - a class loader to be used for loading services listed in features

features - list of supported features

Returns:

the created instance

Throws:

IllegalArgumentException - if some parameters were null

getProcessingEnvironment

public ProcessingEnvironment getProcessingEnvironment()

Returns the current processing environment.

Returns:

the current processing environment

emit

public void emit(CompilationUnit unit,
                 Element... originatingElements)
          throws IOException

Emits the target compilation unit onto suitable location.

Parameters:

unit - target compilation unit

originatingElements - the original elements

Throws:

IOException - if failed to emit by I/O error

IllegalArgumentException - if some parameters were null

findDataModel

public DataModelMirror findDataModel(ClassDescription typeName)

Returns data-model mirror.

Parameters:

typeName - target type name

Returns:

related data-model mirror, or null if not found

Throws:

IllegalArgumentException - if some parameters were null

findDataModel

public DataModelMirror findDataModel(TypeMirror type)

Returns data-model mirror.

Parameters:

type - target type mirror

Returns:

related data-model mirror, or null if not found

Throws:

IllegalArgumentException - if some parameters were null

getOperatorDrivers

public List<OperatorDriver> getOperatorDrivers()

Returns registered operator drivers.

Returns:

operator drivers

findDriver

public OperatorDriver findDriver(TypeElement annotationType)

Returns a registered operator driver related to the annotation type.

Parameters:

annotationType - target annotation type

Returns:

related operator driver, or null if it is not registered

Throws:

IllegalArgumentException - if some parameters were null

findTypeElement

public TypeElement findTypeElement(ClassDescription aClass)

Returns the type element which has the specified qualified name.

Parameters:

aClass - fully qualified type name

Returns:

target type element, or null if it is not found

Throws:

IllegalArgumentException - if some parameters were null

findDeclaredType

public DeclaredType findDeclaredType(ClassDescription aClass)

Returns the type mirror witch has the specified qualified name.

Parameters:

aClass - fully qualified type name

Returns:

target type mirror, or null if it is not found

Throws:

IllegalArgumentException - if some parameters were null

getErasure

public TypeMirror getErasure(TypeMirror type)

Returns the type erasure.

Parameters:

type - original type

Returns:

erased type

Throws:

IllegalArgumentException - if some parameters were null

getMemberName

public String getMemberName(String token)

Returns the normalized member name.

Parameters:

token - the original token

Returns:

the normalized name for members

setResourceGenerated

public void setResourceGenerated(ClassDescription key)

Sets the target resources is generated.

Parameters:

key - the target resource key

isResourceGenerated

public boolean isResourceGenerated(ClassDescription key)

Returns whether the target resources is generated or not.

Parameters:

key - the target resource key

Returns:

true if it is already generated, otherwise false

getWarningAction

public WarningAction getWarningAction()

Returns the warning action type.

Returns:

the warning action type

withWarningAction

public CompileEnvironment withWarningAction(WarningAction newValue)

Sets the warning action type.

Parameters:

newValue - the value to set

Returns:

this

isFlowpartExternalIo

public boolean isFlowpartExternalIo()

Returns whether external I/O declaration is available in flow-parts or not.

Returns:

true if it is available, otherwise false

withFlowpartExternalIo

public CompileEnvironment withFlowpartExternalIo(boolean newValue)

Sets whether external I/O declarations are available in flow-parts or not.

Parameters:

newValue - true iff they are available

Returns:

this

isForceGenerateImplementation

public boolean isForceGenerateImplementation()

Returns whether always generates implementation classes or not.

Returns:

true if it is available, otherwise false

withForceGenerateImplementation

public CompileEnvironment withForceGenerateImplementation(boolean newValue)

Sets whether always generates implementation classes or not.

Parameters:

newValue - true iff it is available

Returns:

this

isForceRegenerateResources

public boolean isForceRegenerateResources()

Returns whether always re-generates resources or not.

Returns:

true if it is available, otherwise false

withForceRegenerateResources

public CompileEnvironment withForceRegenerateResources(boolean newValue)

Sets whether always re-generates resources.

Parameters:

newValue - true iff it is available

Returns:

this

isStrictOperatorParameterOrder

public boolean isStrictOperatorParameterOrder()

Returns whether the operator method parameter must be strict ordered or not.

Returns:

true if it is strict, otherwise false

withStrictOperatorParameterOrder

public CompileEnvironment withStrictOperatorParameterOrder(boolean newValue)

Sets whether the operator method parameter must be strict ordered or not.

Parameters:

newValue - true if it must be strict, otherwise false

Returns:

this

isStrictOptionalOutputConnectivity

public boolean isStrictOptionalOutputConnectivity()

Returns whether or not the operator outputs must not be opened even if they are optional.

Returns:

true if it is strict, otherwise false

Since:

0.10.1

withStrictOptionalOutputConnectivity

public CompileEnvironment withStrictOptionalOutputConnectivity(boolean newValue)

Sets whether or not the operator outputs must not be opened even if they are optional.

Parameters:

newValue - true if it must be strict, otherwise false

Returns:

this

Since:

0.10.1

isForceNormalizeMemberName

public boolean isForceNormalizeMemberName()

Returns whether or not the member names must be normalized.

Returns:

true is normalized, otherwise false

withForceNormalizeMemberName

public CompileEnvironment withForceNormalizeMemberName(boolean newValue)

Sets whether or not the member names must be normalized.

Parameters:

newValue - true is normalized, otherwise false

Returns:

the new value

isEnumConstantParameter

public boolean isEnumConstantParameter()

Returns whether or not the operators can accept enum constants as value parameter.

Returns:

true if operators can accept enum constants, otherwise false

Since:

0.10.2

withEnumConstantParameter

public CompileEnvironment withEnumConstantParameter(boolean newValue)

Sets whether or not the operators can accept enum constants as value parameter.

Parameters:

newValue - true to accept enum constants, otherwise false

Returns:

this

Since:

0.10.2

isUnboundProjection

public boolean isUnboundProjection()

Returns whether or not the operators can accept unbound projective models.

Returns:

true if operators can accept unbound projective models, otherwise false

Since:

0.10.3

withUnboundProjection

public CompileEnvironment withUnboundProjection(boolean newValue)

Sets whether or not the operators can accept unbound projective models.

Parameters:

newValue - true to accept unbound projective models, otherwise false

Returns:

this

Since:

0.10.3