io.sarl.lang.codebuilder.appenders
Class SarlActionSourceAppender
All Superinterfaces:
ISarlActionBuilder
class SarlActionSourceAppender
extends AbstractSourceAppender
implements ISarlActionBuilder
Source appender of a Sarl SarlAction.
See:
"AbstractMemberBuilderFragment.java : appendTo : 194"
Property Summary
Modifier and type Property and description
IBlockExpressionBuilder expression
Create the block of code.
SarlAction sarlAction
Replies the generated element.
org.eclipse.xtext.common.types.access.IJvmTypeProvider typeResolutionContext
Replies the context for type resolution.
Field Summary
Inherited: OVERRIDEN_TYPE_SCOPE_PROVIDER_NAME
Constructor Summary
Constructor and description
new(ISarlActionBuilder)
Action Summary
Modifier and type Action and description
ISarlActionBuilder addAnnotation(String)
Add an annotation.
ISarlActionBuilder addAnnotation(JvmTypeReference)
Add an annotation.
ISarlActionBuilder addException(String)
Add a throwable exception.
ISarlActionBuilder addException(JvmTypeReference)
Add a throwable exception.
ISarlActionBuilder addFiredEvent(String)
Add a fired event.
void addFiredEvent(JvmTypeReference)
Add a fired event.
ISarlActionBuilder addModifier(String)
Add a modifier.
IFormalParameterBuilder addParameter(String)
Add a formal parameter.
ITypeParameterBuilder addTypeParameter(String)
Add a type parameter.
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(EObject,String,String,IJvmTypeProvider)
Initialize the Ecore element.
org.eclipse.emf.ecore.resource.Resource eResource
Replies the resource.
IBlockExpressionBuilder getExpression
Create the block of code.
SarlAction getSarlAction
Replies the generated element.
org.eclipse.xtext.common.types.access.IJvmTypeProvider getTypeResolutionContext
Replies the context for type resolution.
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 and 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 and type parameters.
org.eclipse.xtext.common.types.JvmTypeReference newTypeRef(Notifier,Class<T>,JvmTypeReference*)
Find the reference to the type and type parameters.
ISarlActionBuilder setDocumentation(String)
Change the documentation of the element.
ISarlActionBuilder setReturnType(String)
Change the return type.
ISarlActionBuilder setReturnType(JvmTypeReference)
Change the return type.
java.lang.String toString
Inherited: build(EObject,ISourceAppender), isFormatting, resolvesTypes(EObject), setFormatting(boolean)
Property Details
expression
val expression : IBlockExpressionBuilder
Create the block of code.

This property is an alias for the action: getExpression

Returns:
the block builder.
See:
"AbstractMemberBuilderFragment.java : appendTo : 1445"
sarlAction
val sarlAction : SarlAction
Replies the generated element.

This property is an alias for the action: getSarlAction

See:
"AbstractMemberBuilderFragment.java : appendTo : 962"
typeResolutionContext
val typeResolutionContext : org.eclipse.xtext.common.types.access.IJvmTypeProvider
Replies the context for type resolution.

This property is an alias for the action: getTypeResolutionContext

Returns:
the context or null if the Ecore object is the context.
See:
"AbstractMemberBuilderFragment.java : appendTo : 598"
Constructor Details
new(ISarlActionBuilder)
new(ISarlActionBuilder)
Action Details
addAnnotation(String)
def addAnnotation(String) : ISarlActionBuilder
Add an annotation.
Parameters:
type - the qualified name of the annotation
Returns:
this
See:
"AbstractMemberBuilderFragment.java : appendTo : 1508"
addAnnotation(JvmTypeReference)
def addAnnotation(JvmTypeReference) : ISarlActionBuilder
Add an annotation.
Parameters:
type - the annotation type
Returns:
this
See:
"AbstractMemberBuilderFragment.java : appendTo : 1552"
addException(String)
def addException(String) : ISarlActionBuilder
Add a throwable exception.
Parameters:
type - the fully qualified name of the exception.
Returns:
this
See:
"AbstractMemberBuilderFragment.java : appendTo : 1158"
addException(JvmTypeReference)
def addException(JvmTypeReference) : ISarlActionBuilder
Add a throwable exception.
Parameters:
type - the exception.
Returns:
this
See:
"AbstractMemberBuilderFragment.java : appendTo : 1201"
addFiredEvent(String)
def addFiredEvent(String) : ISarlActionBuilder
Add a fired event.
Parameters:
type - the fully qualified name of the event.
Returns:
this
See:
"AbstractMemberBuilderFragment.java : appendTo : 1246"
addFiredEvent(JvmTypeReference)
def addFiredEvent(JvmTypeReference)
Add a fired event.
Parameters:
type - the event.
See:
"AbstractMemberBuilderFragment.java : appendTo : 1287"
addModifier(String)
def addModifier(String) : ISarlActionBuilder
Add a modifier.
Parameters:
modifier - the modifier to add.
Returns:
this
See:
"AbstractMemberBuilderFragment.java : appendTo : 1602"
addParameter(String)
def addParameter(String) : IFormalParameterBuilder
Add a formal parameter.
Parameters:
name - the name of the formal parameter.
See:
"AbstractMemberBuilderFragment.java : appendTo : 1114"
addTypeParameter(String)
def addTypeParameter(String) : ITypeParameterBuilder
Add a type parameter.
Parameters:
name - the simple name of the type parameter.
Returns:
the builder of type parameter.
See:
"AbstractMemberBuilderFragment.java : appendTo : 1683"
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:
"AbstractMemberBuilderFragment.java : appendTo : 569"
eInit(EObject,String,String,IJvmTypeProvider)
def eInit(EObject,String,String,IJvmTypeProvider)
Initialize the Ecore element.
Parameters:
container - the container of the SarlAction.
name - the name of the SarlAction.
modifier - the major/default modifier to be associated to the member.
context - the context in which type resolution must be applied.
See:
"AbstractMemberBuilderFragment.java : appendTo : 632"
eResource
def eResource : org.eclipse.emf.ecore.resource.Resource
Replies the resource.
See:
"AbstractMemberBuilderFragment.java : appendTo : 996"
getExpression
def getExpression : IBlockExpressionBuilder
Create the block of code.
Returns:
the block builder.
See:
"AbstractMemberBuilderFragment.java : appendTo : 1445"
getSarlAction
def getSarlAction : SarlAction
Replies the generated element.
See:
"AbstractMemberBuilderFragment.java : appendTo : 962"
getTypeResolutionContext
def getTypeResolutionContext : org.eclipse.xtext.common.types.access.IJvmTypeProvider
Replies the context for type resolution.
Returns:
the context or null if the Ecore object is the context.
See:
"AbstractMemberBuilderFragment.java : appendTo : 598"
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:
"AbstractMemberBuilderFragment.java : appendTo : 406"
newTypeRef(Class<T>,JvmTypeReference*)
def newTypeRef(Class<T>,JvmTypeReference*) : org.eclipse.xtext.common.types.JvmTypeReference
Find the reference to the type and type parameters.
Parameters:
type - the type to reference
args - the type arguments to put in the reference to the given type
Returns:
the type reference.
See:
"AbstractMemberBuilderFragment.java : appendTo : 496"
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:
"AbstractMemberBuilderFragment.java : appendTo : 434"
newTypeRef(JvmType,JvmTypeReference*)
def newTypeRef(JvmType,JvmTypeReference*) : org.eclipse.xtext.common.types.JvmTypeReference
Find the reference to the type and type parameters.
Parameters:
type - the type to reference
args - the type arguments to put in the reference to the given type
Returns:
the type reference.
See:
"AbstractMemberBuilderFragment.java : appendTo : 464"
newTypeRef(Notifier,Class<T>,JvmTypeReference*)
def newTypeRef(Notifier,Class<T>,JvmTypeReference*) : org.eclipse.xtext.common.types.JvmTypeReference
Find the reference to the type and type parameters.
Parameters:
context - the context in which the type is defined
type - the type to reference
args - the type arguments to put in the reference to the given type
Returns:
the type reference.
See:
"AbstractMemberBuilderFragment.java : appendTo : 530"
setDocumentation(String)
def setDocumentation(String) : ISarlActionBuilder
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"
setReturnType(String)
def setReturnType(String) : ISarlActionBuilder
Change the return type.
Parameters:
type - the return type of the member.
Returns:
this
See:
"AbstractMemberBuilderFragment.java : appendTo : 1329"
setReturnType(JvmTypeReference)
def setReturnType(JvmTypeReference) : ISarlActionBuilder
Change the return type.
Parameters:
type - the return type of the member.
Returns:
this
See:
"AbstractMemberBuilderFragment.java : appendTo : 1385"
toString
def toString : java.lang.String
See:
"AbstractMemberBuilderFragment.java : appendTo : 1638"