com.asakusafw.dmdl.java.emitter

Class EmitContext

java.lang.Object

com.asakusafw.dmdl.java.emitter.EmitContext

public final class EmitContext
extends Object

Emitting context.

Since:

0.2.0

Version:

0.7.5

Constructor Summary

Constructors

Constructor and Description
EmitContext(DmdlSemantics semantics, Configuration config, ModelDeclaration model, String categoryName, String typeNamePattern) Creates and returns a new instance.

Method Summary

Modifier and Type	Method and Description
SimpleName	createVariableName(String hint) Returns a variable name which is different to other property names.
void	emit(TypeDeclaration type) Emits the type declaration as the suitable Java source program.
Configuration	getConfiguration() Returns the current configuration.
Type	getContainerType(PropertyReferenceDeclaration reference) Returns the collection type of target reference.
String	getDescription(Declaration declaration) Returns the description text of the declaration.
Type	getElementType(PropertyReferenceDeclaration reference) Returns the element type of target reference.
Expression	getFieldInitializer(PropertyDeclaration property) Returns the corresponded property initializer.
SimpleName	getFieldName(MemberDeclaration property) Returns the corresponded property name.
Type	getFieldType(PropertyDeclaration property) Returns the corresponded property data type.
static Class<?>	getFieldTypeAsClass(BasicTypeKind type) Returns the corresponded property data type as related class object.
static Class<?>	getFieldTypeAsClass(PropertyDeclaration property) Returns the corresponded property data type as related class object.
ModelFactory	getModelFactory() Returns Java DOM factory in use.
SimpleName	getOptionGetterName(PropertyDeclaration property) Returns the corresponded option getter name.
SimpleName	getOptionSetterName(PropertyDeclaration property) Returns the corresponded option setter name.
QualifiedName	getQualifiedTypeName() Returns the qualified name of processing type.
QualifiedName	getQualifiedTypeName(ModelSymbol model) Returns the simple name of the target data model class.
SimpleName	getReferenceGetterName(PropertyReferenceDeclaration reference) Returns the corresponded reference getter name.
DmdlSemantics	getSemantics() Returns the root semantics model.
SimpleName	getTypeName() Returns the simple name of processing type.
SimpleName	getTypeName(ModelSymbol model) Returns the simple name of the target data model class.
SimpleName	getValueGetterName(PropertyDeclaration property) Returns the corresponded value getter name.
SimpleName	getValueSetterName(PropertyDeclaration property) Returns the corresponded value setter name.
Type	getValueType(PropertyDeclaration property) Returns the corresponded property value type.
static Class<?>	getValueTypeAsClass(PropertyDeclaration property) Returns the corresponded property value type as related class object.
Type	resolve(ModelSymbol model) Resolves the model symbol to the corresponded Java DOM type symbol.
Type	resolve(Name name) Resolves the qualified type name to the corresponded type symbol.
Type	resolve(Type type) Resolves the runtime type to the corresponded Java DOM type symbol.
Type	resolve(Type type) Resolves the Java DOM type to imported type representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmitContext

public EmitContext(DmdlSemantics semantics,
                   Configuration config,
                   ModelDeclaration model,
                   String categoryName,
                   String typeNamePattern)

Creates and returns a new instance.

Parameters:

semantics - the root semantics model

config - the configuration of this processing

model - the model to process

categoryName - the category name of processing

typeNamePattern - the type name pattern in MessageFormat.format(String, Object...)

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

getModelFactory

public ModelFactory getModelFactory()

Returns Java DOM factory in use.

Returns:

the Java DOM factory

getSemantics

public DmdlSemantics getSemantics()

Returns the root semantics model.

Returns:

the semantics model

getConfiguration

public Configuration getConfiguration()

Returns the current configuration.

Returns:

the current configuration

getTypeName

public SimpleName getTypeName()

Returns the simple name of processing type.

Returns:

the type name

getQualifiedTypeName

public QualifiedName getQualifiedTypeName()

Returns the qualified name of processing type.

Returns:

the type name

getTypeName

public SimpleName getTypeName(ModelSymbol model)

Returns the simple name of the target data model class.

Parameters:

model - the target symbol

Returns:

the simple name of the target symbol

Since:

0.7.5

getQualifiedTypeName

public QualifiedName getQualifiedTypeName(ModelSymbol model)

Returns the simple name of the target data model class.

Parameters:

model - the target symbol

Returns:

the simple name of the target symbol

Since:

0.7.5

emit

public void emit(TypeDeclaration type)
          throws IOException

Emits the type declaration as the suitable Java source program.

Parameters:

type - the declaration

Throws:

IOException - if failed to emit a Java program

IllegalArgumentException - if some parameters were null

resolve

public Type resolve(ModelSymbol model)

Resolves the model symbol to the corresponded Java DOM type symbol.

Parameters:

model - the model symbol

Returns:

the corresponded type symbol

Throws:

IllegalArgumentException - if some parameters were null

resolve

public Type resolve(Type type)

Resolves the runtime type to the corresponded Java DOM type symbol.

Parameters:

type - the runtime type

Returns:

the corresponded type symbol

Throws:

IllegalArgumentException - if some parameters were null

resolve

public Type resolve(Name name)

Resolves the qualified type name to the corresponded type symbol.

Parameters:

name - the qualified type name

Returns:

the corresponded type symbol

Throws:

IllegalArgumentException - if some parameters were null

resolve

public Type resolve(Type type)

Resolves the Java DOM type to imported type representation.

Parameters:

type - the Java DOM type

Returns:

the imported type representation

Throws:

IllegalArgumentException - if some parameters were null

getFieldName

public SimpleName getFieldName(MemberDeclaration property)

Returns the corresponded property name.

Parameters:

property - target property

Returns:

the corresponded name

Throws:

IllegalArgumentException - if some parameters were null

getValueType

public Type getValueType(PropertyDeclaration property)

Returns the corresponded property value type.

Parameters:

property - target property

Returns:

the corresponded type

Throws:

IllegalArgumentException - if some parameters were null

getValueTypeAsClass

public static Class<?> getValueTypeAsClass(PropertyDeclaration property)

Returns the corresponded property value type as related class object.

Parameters:

property - target property

Returns:

the corresponded type

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.7.0

getFieldType

public Type getFieldType(PropertyDeclaration property)

Returns the corresponded property data type.

Parameters:

property - target property

Returns:

the corresponded type

Throws:

IllegalArgumentException - if some parameters were null

getContainerType

public Type getContainerType(PropertyReferenceDeclaration reference)

Returns the collection type of target reference.

Parameters:

reference - target reference

Returns:

the corresponded type

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.9.2

getElementType

public Type getElementType(PropertyReferenceDeclaration reference)

Returns the element type of target reference.

Parameters:

reference - target reference

Returns:

the corresponded type

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.9.2

getFieldTypeAsClass

public static Class<?> getFieldTypeAsClass(PropertyDeclaration property)

Returns the corresponded property data type as related class object.

Parameters:

property - target property

Returns:

the corresponded type

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.7.0

getFieldTypeAsClass

public static Class<?> getFieldTypeAsClass(BasicTypeKind type)

Returns the corresponded property data type as related class object.

Parameters:

type - the type

Returns:

the corresponded type

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.7.0

getFieldInitializer

public Expression getFieldInitializer(PropertyDeclaration property)

Returns the corresponded property initializer.

Parameters:

property - target property

Returns:

the corresponded expression

Throws:

IllegalArgumentException - if some parameters were null

getValueGetterName

public SimpleName getValueGetterName(PropertyDeclaration property)

Returns the corresponded value getter name.

Parameters:

property - target property

Returns:

the corresponded name

Throws:

IllegalArgumentException - if some parameters were null

getValueSetterName

public SimpleName getValueSetterName(PropertyDeclaration property)

Returns the corresponded value setter name.

Parameters:

property - target property

Returns:

the corresponded name

Throws:

IllegalArgumentException - if some parameters were null

getOptionGetterName

public SimpleName getOptionGetterName(PropertyDeclaration property)

Returns the corresponded option getter name.

Parameters:

property - target property

Returns:

the corresponded name

Throws:

IllegalArgumentException - if some parameters were null

getOptionSetterName

public SimpleName getOptionSetterName(PropertyDeclaration property)

Returns the corresponded option setter name.

Parameters:

property - target property

Returns:

the corresponded name

Throws:

IllegalArgumentException - if some parameters were null

getReferenceGetterName

public SimpleName getReferenceGetterName(PropertyReferenceDeclaration reference)

Returns the corresponded reference getter name.

Parameters:

reference - target reference

Returns:

the corresponded name

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.9.2

createVariableName

public SimpleName createVariableName(String hint)

Returns a variable name which is different to other property names.

Parameters:

hint - the naming hint

Returns:

a variable name

Throws:

IllegalArgumentException - if some parameters were null

getDescription

public String getDescription(Declaration declaration)

Returns the description text of the declaration.

Parameters:

declaration - the target declaration

Returns:

the description text

Throws:

IllegalArgumentException - if some parameters were null