io.sarl.lang.codebuilder.appenders
Class SarlAnnotationTypeSourceAppender
All Superinterfaces:
ISarlAnnotationTypeBuilder
class SarlAnnotationTypeSourceAppender
extends AbstractSourceAppender
implements ISarlAnnotationTypeBuilder
Source adapter of a Sarl SarlAnnotationType.
See:
"TopElementBuilderFragment.java : appendTo : 354"
Property Summary
Modifier and type Property and description
org.eclipse.xtext.common.types.JvmDeclaredType jvmDeclaredType
Replies the JVM declared type for this generated SarlAnnotationType.
SarlAnnotationType sarlAnnotationType
Replies the generated SarlAnnotationType.
org.eclipse.xtext.common.types.JvmTypeReference sarlAnnotationTypeReference
Replies the reference to the generated SarlAgent.
org.eclipse.xtext.common.types.access.IJvmTypeProvider typeResolutionContext
Field Summary
Inherited: OVERRIDEN_TYPE_SCOPE_PROVIDER_NAME
Constructor Summary
Constructor and description
new(ISarlAnnotationTypeBuilder)
Action Summary
Modifier and type Action and description
ISarlAnnotationTypeBuilder addModifier(String)
Add a modifier.
ISarlAnnotationTypeBuilder addSarlAnnotationType(String)
Create a SarlAnnotationType.
ISarlClassBuilder addSarlClass(String)
Create a SarlClass.
ISarlEnumerationBuilder addSarlEnumeration(String)
Create a SarlEnumeration.
ISarlFieldBuilder addSarlField(String)
Create a SarlField
ISarlInterfaceBuilder addSarlInterface(String)
Create a SarlInterface.
ISarlFieldBuilder addValSarlField(String)
Create a SarlField.
ISarlFieldBuilder addVarSarlField(String)
Create a SarlField.
void build(ISourceAppender)
Fill the given receiver with the serialization of the element that is associated to this appender.
void dispose
Dispose the resource.
void eInit(SarlScript,String,IJvmTypeProvider)
Initialize the Ecore element when inside a script.
void eInit(XtendTypeDeclaration,String,IJvmTypeProvider)
Initialize the Ecore element when inner type declaration.
org.eclipse.emf.ecore.resource.Resource eResource
Replies the resource to which the SarlAnnotationType is attached.
org.eclipse.xtext.common.types.JvmDeclaredType getJvmDeclaredType
Replies the JVM declared type for this generated SarlAnnotationType.
SarlAnnotationType getSarlAnnotationType
Replies the generated SarlAnnotationType.
org.eclipse.xtext.common.types.JvmTypeReference getSarlAnnotationTypeReference
Replies the reference to the generated SarlAgent.
org.eclipse.xtext.common.types.access.IJvmTypeProvider getTypeResolutionContext
org.eclipse.xtext.common.types.JvmTypeReference newTypeRef(String)
Find the reference to the type with the given name.
org.eclipse.xtext.common.types.JvmTypeReference newTypeRef(Class<T>,JvmTypeReference*)
Find the reference to the type with the given type parameters.
org.eclipse.xtext.common.types.JvmTypeReference newTypeRef(Notifier,String)
Find the reference to the type with the given name.
org.eclipse.xtext.common.types.JvmTypeReference newTypeRef(JvmType,JvmTypeReference*)
Find the reference to the type with the given type parameters.
org.eclipse.xtext.common.types.JvmTypeReference newTypeRef(Notifier,Class<T>,JvmTypeReference*)
Find the reference to the type with the given type parameters.
ISarlAnnotationTypeBuilder setDocumentation(String)
Change the documentation of the element.
java.lang.String toString
Inherited: build(EObject,ISourceAppender), isFormatting, resolvesTypes(EObject), setFormatting(boolean)
Property Details
jvmDeclaredType
val jvmDeclaredType : org.eclipse.xtext.common.types.JvmDeclaredType
Replies the JVM declared type for this generated SarlAnnotationType.

This property is an alias for the action: getJvmDeclaredType

Returns:
the type, never null .
Since:
0.15
See:
"TopElementBuilderFragment.java : appendTo : 1893"
sarlAnnotationType
val sarlAnnotationType : SarlAnnotationType
Replies the generated SarlAnnotationType.

This property is an alias for the action: getSarlAnnotationType

See:
"TopElementBuilderFragment.java : appendTo : 1798"
sarlAnnotationTypeReference
val sarlAnnotationTypeReference : org.eclipse.xtext.common.types.JvmTypeReference
Replies the reference to the generated SarlAgent.

This property is an alias for the action: getSarlAnnotationTypeReference

Since:
0.15
See:
"TopElementBuilderFragment.java : appendTo : 1838"
typeResolutionContext
val typeResolutionContext : org.eclipse.xtext.common.types.access.IJvmTypeProvider

This property is an alias for the action: getTypeResolutionContext

Constructor Details
new(ISarlAnnotationTypeBuilder)
new(ISarlAnnotationTypeBuilder)
Action Details
addModifier(String)
def addModifier(String) : ISarlAnnotationTypeBuilder
Add a modifier.
Parameters:
modifier - the modifier to add.
Returns:
this .
See:
"TopElementBuilderFragment.java : appendTo : 2492"
addSarlAnnotationType(String)
def addSarlAnnotationType(String) : ISarlAnnotationTypeBuilder
Create a SarlAnnotationType.
Parameters:
name - the name of the SarlAnnotationType.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 564"
addSarlClass(String)
def addSarlClass(String) : ISarlClassBuilder
Create a SarlClass.
Parameters:
name - the name of the SarlClass.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 564"
addSarlEnumeration(String)
def addSarlEnumeration(String) : ISarlEnumerationBuilder
Create a SarlEnumeration.
Parameters:
name - the name of the SarlEnumeration.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 564"
addSarlField(String)
def addSarlField(String) : ISarlFieldBuilder
Create a SarlField. *

This function is equivalent to #addVarSarlField.
Parameters:
name - the name of the SarlField.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 706"
addSarlInterface(String)
def addSarlInterface(String) : ISarlInterfaceBuilder
Create a SarlInterface.
Parameters:
name - the name of the SarlInterface.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 564"
addValSarlField(String)
def addValSarlField(String) : ISarlFieldBuilder
Create a SarlField.
Parameters:
name - the name of the SarlField.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 564"
addVarSarlField(String)
def addVarSarlField(String) : ISarlFieldBuilder
Create a SarlField.
Parameters:
name - the name of the SarlField.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 564"
build(ISourceAppender)
def build(ISourceAppender)
 throws java.io.IOException
Fill the given receiver with the serialization of the element that is associated to this appender.
Parameters:
appender - the receiver of the source code.
Throws exception:
  • java.io.IOException: if there is error during the serialization.
See:
"AbstractSubCodeBuilderFragment.java : appendTo : 550"
dispose
def dispose
Dispose the resource.
See:
"TopElementBuilderFragment.java : appendTo : 1613"
eInit(SarlScript,String,IJvmTypeProvider)
def eInit(SarlScript,String,IJvmTypeProvider)
Initialize the Ecore element when inside a script.
Parameters:
script - the SARL script in which this SarlAnnotationType is added.
name - the simple name of the SarlAnnotationType.
context - the context in which the resolution of types must be done.
See:
"TopElementBuilderFragment.java : appendTo : 1662"
eInit(XtendTypeDeclaration,String,IJvmTypeProvider)
def eInit(XtendTypeDeclaration,String,IJvmTypeProvider)
Initialize the Ecore element when inner type declaration.
Parameters:
container - the Ecore type that must contain this new SarlAnnotationType.
name - the simple name of the SarlAnnotationType.
context - the context in which the resolution of types must be done.
See:
"TopElementBuilderFragment.java : appendTo : 1741"
eResource
def eResource : org.eclipse.emf.ecore.resource.Resource
Replies the resource to which the SarlAnnotationType is attached.
See:
"TopElementBuilderFragment.java : appendTo : 1928"
getJvmDeclaredType
def getJvmDeclaredType : org.eclipse.xtext.common.types.JvmDeclaredType
Replies the JVM declared type for this generated SarlAnnotationType.
Returns:
the type, never null .
Since:
0.15
See:
"TopElementBuilderFragment.java : appendTo : 1893"
getSarlAnnotationType
def getSarlAnnotationType : SarlAnnotationType
Replies the generated SarlAnnotationType.
See:
"TopElementBuilderFragment.java : appendTo : 1798"
getSarlAnnotationTypeReference
def getSarlAnnotationTypeReference : org.eclipse.xtext.common.types.JvmTypeReference
Replies the reference to the generated SarlAgent.
Since:
0.15
See:
"TopElementBuilderFragment.java : appendTo : 1838"
getTypeResolutionContext
def getTypeResolutionContext : org.eclipse.xtext.common.types.access.IJvmTypeProvider
newTypeRef(String)
def newTypeRef(String) : org.eclipse.xtext.common.types.JvmTypeReference
Find the reference to the type with the given name.
Parameters:
typeName - the fully qualified name of the type
Returns:
the type reference.
See:
"TopElementBuilderFragment.java : appendTo : 1426"
newTypeRef(Class<T>,JvmTypeReference*)
def newTypeRef(Class<T>,JvmTypeReference*) : org.eclipse.xtext.common.types.JvmTypeReference
Find the reference to the type with the given type parameters.
Parameters:
type - the type to reference
args - the type parameters to add to the to reference to the given type
Returns:
the type reference.
See:
"TopElementBuilderFragment.java : appendTo : 1516"
newTypeRef(Notifier,String)
def newTypeRef(Notifier,String) : org.eclipse.xtext.common.types.JvmTypeReference
Find the reference to the type with the given name.
Parameters:
context - the context for the type reference use
typeName - the fully qualified name of the type
Returns:
the type reference.
See:
"TopElementBuilderFragment.java : appendTo : 1454"
newTypeRef(JvmType,JvmTypeReference*)
def newTypeRef(JvmType,JvmTypeReference*) : org.eclipse.xtext.common.types.JvmTypeReference
Find the reference to the type with the given type parameters.
Parameters:
type - the type to reference
args - the type parameters to add to the to reference to the given type
Returns:
the type reference.
See:
"TopElementBuilderFragment.java : appendTo : 1484"
newTypeRef(Notifier,Class<T>,JvmTypeReference*)
def newTypeRef(Notifier,Class<T>,JvmTypeReference*) : org.eclipse.xtext.common.types.JvmTypeReference
Find the reference to the type with the given type parameters.
Parameters:
context - the context in which the type is defined
type - the type to reference
args - the type parameters to add to the to reference to the given type
Returns:
the type reference.
See:
"TopElementBuilderFragment.java : appendTo : 1550"
setDocumentation(String)
def setDocumentation(String) : ISarlAnnotationTypeBuilder
Change the documentation of the element.

The documentation will be displayed just before the element.
Parameters:
doc - the documentation.
Returns:
this .
See:
"AbstractSubCodeBuilderFragment.java : appendTo : 603"
toString
def toString : java.lang.String
See:
"TopElementBuilderFragment.java : appendTo : 1625"