io.sarl.lang.codebuilder.appenders
Class SarlEventSourceAppender
All Superinterfaces:
ISarlEventBuilder
class SarlEventSourceAppender
extends AbstractSourceAppender
implements ISarlEventBuilder
Source adapter of a Sarl SarlEvent.
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 SarlEvent.
SarlEvent sarlEvent
Replies the generated SarlEvent.
org.eclipse.xtext.common.types.access.IJvmTypeProvider typeResolutionContext
Field Summary
Inherited: OVERRIDEN_TYPE_SCOPE_PROVIDER_NAME
Constructor Summary
Constructor and description
new(ISarlEventBuilder)
Action Summary
Modifier and type Action and description
ISarlEventBuilder addModifier(String)
Add a modifier.
ISarlConstructorBuilder addSarlConstructor
Create a SarlConstructor.
ISarlFieldBuilder addSarlField(String)
Create a SarlField
ITypeParameterBuilder addTypeParameter(String)
Add a type parameter.
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.
org.eclipse.emf.ecore.resource.Resource eResource
Replies the resource to which the SarlEvent is attached.
org.eclipse.xtext.common.types.JvmDeclaredType getJvmDeclaredType
Replies the JVM declared type for this generated SarlEvent.
SarlEvent getSarlEvent
Replies the generated SarlEvent.
org.eclipse.xtext.common.types.JvmTypeReference getSarlEventReference(JvmTypeReference*)
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.
ISarlEventBuilder setDocumentation(String)
Change the documentation of the element.
ISarlEventBuilder setExtends(String)
Change the super type.
ISarlEventBuilder setExtends(JvmTypeReference)
Change the super type.
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 SarlEvent.

This property is an alias for the action: getJvmDeclaredType

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

This property is an alias for the action: getSarlEvent

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

This property is an alias for the action: getTypeResolutionContext

Constructor Details
new(ISarlEventBuilder)
new(ISarlEventBuilder)
Action Details
addModifier(String)
def addModifier(String) : ISarlEventBuilder
Add a modifier.
Parameters:
modifier - the modifier to add.
Returns:
this .
See:
"TopElementBuilderFragment.java : appendTo : 2492"
addSarlConstructor
def addSarlConstructor : ISarlConstructorBuilder
Create a SarlConstructor.
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"
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:
"TopElementBuilderFragment.java : appendTo : 2546"
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 SarlEvent is added.
name - the simple name of the SarlEvent.
context - the context in which the resolution of types must be done.
See:
"TopElementBuilderFragment.java : appendTo : 1662"
eResource
def eResource : org.eclipse.emf.ecore.resource.Resource
Replies the resource to which the SarlEvent is attached.
See:
"TopElementBuilderFragment.java : appendTo : 1928"
getJvmDeclaredType
def getJvmDeclaredType : org.eclipse.xtext.common.types.JvmDeclaredType
Replies the JVM declared type for this generated SarlEvent.
Returns:
the type, never null .
Since:
0.15
See:
"TopElementBuilderFragment.java : appendTo : 1893"
getSarlEvent
def getSarlEvent : SarlEvent
Replies the generated SarlEvent.
See:
"TopElementBuilderFragment.java : appendTo : 1798"
getSarlEventReference(JvmTypeReference*)
def getSarlEventReference(JvmTypeReference*) : org.eclipse.xtext.common.types.JvmTypeReference
Replies the reference to the generated SarlAgent.
Parameters:
args - the generic type arguments to put inside the reference.
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) : ISarlEventBuilder
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"
setExtends(String)
def setExtends(String) : ISarlEventBuilder
Change the super type.
Parameters:
superType - the qualified name of the super type, or null if the default type.
Returns:
this
See:
"TopElementBuilderFragment.java : appendTo : 1984"
setExtends(JvmTypeReference)
def setExtends(JvmTypeReference) : ISarlEventBuilder
Change the super type.
Parameters:
superType - the super type, or null if the default type.
Returns:
this .
See:
"TopElementBuilderFragment.java : appendTo : 2085"
toString
def toString : java.lang.String
See:
"TopElementBuilderFragment.java : appendTo : 1625"