io.sarl.lang.codebuilder.builders
Interface ISarlBehaviorBuilder
All Known Implementing Classes:
SarlBehaviorSourceAppender, SarlBehaviorBuilderImpl
interface ISarlBehaviorBuilder
Builder of a Sarl SarlBehavior.
See:
"TopElementBuilderFragment.java : appendTo : 303"
Property Summary
Modifier and type Property and description
org.eclipse.xtext.common.types.JvmDeclaredType jvmDeclaredType
Replies the JVM declared type for this generated SarlBehavior.
SarlBehavior sarlBehavior
Replies the generated SarlBehavior.
org.eclipse.xtext.common.types.JvmTypeReference sarlBehaviorReference
Replies the reference to the generated SarlAgent.
org.eclipse.xtext.common.types.access.IJvmTypeProvider typeResolutionContext
Replies the context for type resolution.
Action Summary
Modifier and type Action and description
abstract ISarlActionBuilder addDefSarlAction(String)
Create a SarlAction.
abstract ISarlBehaviorBuilder addModifier(String)
Add a modifier.
abstract ISarlActionBuilder addOverrideSarlAction(String)
Create a SarlAction.
abstract ISarlActionBuilder addSarlAction(String)
Create a SarlAction
abstract ISarlAnnotationTypeBuilder addSarlAnnotationType(String)
Create a SarlAnnotationType.
abstract ISarlBehaviorUnitBuilder addSarlBehaviorUnit(String)
Create a SarlBehaviorUnit.
abstract ISarlBehaviorUnitBuilder addSarlBehaviorUnit(JvmParameterizedTypeReference)
Create a SarlBehaviorUnit.
abstract ISarlBehaviorBuilder addSarlCapacityUses(String*)
Create a SarlCapacityUses.
abstract ISarlBehaviorBuilder addSarlCapacityUses(JvmParameterizedTypeReference*)
Create a SarlCapacityUses.
abstract ISarlClassBuilder addSarlClass(String)
Create a SarlClass.
abstract ISarlConstructorBuilder addSarlConstructor
Create a SarlConstructor.
abstract ISarlEnumerationBuilder addSarlEnumeration(String)
Create a SarlEnumeration.
abstract ISarlFieldBuilder addSarlField(String)
Create a SarlField
abstract ISarlInterfaceBuilder addSarlInterface(String)
Create a SarlInterface.
abstract ISarlBehaviorBuilder addSarlRequiredCapacity(String*)
Create a SarlRequiredCapacity.
abstract ISarlBehaviorBuilder addSarlRequiredCapacity(JvmParameterizedTypeReference*)
Create a SarlRequiredCapacity.
abstract ISarlFieldBuilder addValSarlField(String)
Create a SarlField.
abstract ISarlFieldBuilder addVarSarlField(String)
Create a SarlField.
abstract void dispose
Dispose the resource.
abstract void eInit(SarlScript,String,IJvmTypeProvider)
Initialize the Ecore element when inside a script.
abstract org.eclipse.emf.ecore.resource.Resource eResource
Replies the resource to which the SarlBehavior is attached.
abstract org.eclipse.xtext.common.types.JvmDeclaredType getJvmDeclaredType
Replies the JVM declared type for this generated SarlBehavior.
abstract SarlBehavior getSarlBehavior
Replies the generated SarlBehavior.
abstract org.eclipse.xtext.common.types.JvmTypeReference getSarlBehaviorReference
Replies the reference to the generated SarlAgent.
abstract org.eclipse.xtext.common.types.access.IJvmTypeProvider getTypeResolutionContext
Replies the context for type resolution.
abstract org.eclipse.xtext.common.types.JvmTypeReference newTypeRef(String)
Find the reference to the type with the given name.
abstract org.eclipse.xtext.common.types.JvmTypeReference newTypeRef(Class<T>,JvmTypeReference*)
Find the reference to the type with the given type parameters.
abstract org.eclipse.xtext.common.types.JvmTypeReference newTypeRef(Notifier,String)
Find the reference to the type with the given name.
abstract org.eclipse.xtext.common.types.JvmTypeReference newTypeRef(JvmType,JvmTypeReference*)
Find the reference to the type with the given type parameters.
abstract org.eclipse.xtext.common.types.JvmTypeReference newTypeRef(Notifier,Class<T>,JvmTypeReference*)
Find the reference to the type with the given type parameters.
abstract ISarlBehaviorBuilder setDocumentation(String)
Change the documentation of the element.
abstract ISarlBehaviorBuilder setExtends(String)
Change the super type.
abstract ISarlBehaviorBuilder setExtends(JvmTypeReference)
Change the super type.
Property Details
jvmDeclaredType
val jvmDeclaredType : org.eclipse.xtext.common.types.JvmDeclaredType
Replies the JVM declared type for this generated SarlBehavior.

This property is an alias for the action: getJvmDeclaredType

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

This property is an alias for the action: getSarlBehavior

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

This property is an alias for the action: getSarlBehaviorReference

Since:
0.15
See:
"TopElementBuilderFragment.java : appendTo : 1838"
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:
"TopElementBuilderFragment.java : appendTo : 1582"
Action Details
addDefSarlAction(String)
def addDefSarlAction(String) : ISarlActionBuilder
Create a SarlAction.
Parameters:
name - the name of the SarlAction.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 564"
addModifier(String)
def addModifier(String) : ISarlBehaviorBuilder
Add a modifier.
Parameters:
modifier - the modifier to add.
Returns:
this .
See:
"TopElementBuilderFragment.java : appendTo : 2492"
addOverrideSarlAction(String)
def addOverrideSarlAction(String) : ISarlActionBuilder
Create a SarlAction.
Parameters:
name - the name of the SarlAction.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 564"
addSarlAction(String)
def addSarlAction(String) : ISarlActionBuilder
Create a SarlAction. *

This function is equivalent to #addDefSarlAction.
Parameters:
name - the name of the SarlAction.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 706"
addSarlAnnotationType(String)
def addSarlAnnotationType(String) : ISarlAnnotationTypeBuilder
Create a SarlAnnotationType.
Parameters:
name - the name of the SarlAnnotationType.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 564"
addSarlBehaviorUnit(String)
def addSarlBehaviorUnit(String) : ISarlBehaviorUnitBuilder
Create a SarlBehaviorUnit.
Parameters:
name - the type of the SarlBehaviorUnit.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 564"
addSarlBehaviorUnit(JvmParameterizedTypeReference)
def addSarlBehaviorUnit(JvmParameterizedTypeReference) : ISarlBehaviorUnitBuilder
Create a SarlBehaviorUnit.
Parameters:
name - the type of the SarlBehaviorUnit.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 626"
addSarlCapacityUses(String*)
def addSarlCapacityUses(String*) : ISarlBehaviorBuilder
Create a SarlCapacityUses.
Parameters:
name - the types referenced by the SarlCapacityUses.
Returns:
this .
See:
"TopElementBuilderFragment.java : appendTo : 1041"
addSarlCapacityUses(JvmParameterizedTypeReference*)
def addSarlCapacityUses(JvmParameterizedTypeReference*) : ISarlBehaviorBuilder
Create a SarlCapacityUses.
Parameters:
name - the types referenced by the SarlCapacityUses.
Returns:
this .
See:
"TopElementBuilderFragment.java : appendTo : 1145"
addSarlClass(String)
def addSarlClass(String) : ISarlClassBuilder
Create a SarlClass.
Parameters:
name - the name of the SarlClass.
Returns:
the builder.
See:
"TopElementBuilderFragment.java : appendTo : 564"
addSarlConstructor
def addSarlConstructor : ISarlConstructorBuilder
Create a SarlConstructor.
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"
addSarlRequiredCapacity(String*)
def addSarlRequiredCapacity(String*) : ISarlBehaviorBuilder
Create a SarlRequiredCapacity.
Parameters:
name - the types referenced by the SarlRequiredCapacity.
Returns:
this .
See:
"TopElementBuilderFragment.java : appendTo : 1041"
addSarlRequiredCapacity(JvmParameterizedTypeReference*)
def addSarlRequiredCapacity(JvmParameterizedTypeReference*) : ISarlBehaviorBuilder
Create a SarlRequiredCapacity.
Parameters:
name - the types referenced by the SarlRequiredCapacity.
Returns:
this .
See:
"TopElementBuilderFragment.java : appendTo : 1145"
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"
dispose
def dispose
Dispose the resource.
See:
"TopElementBuilderFragment.java : appendTo : 1604"
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 SarlBehavior is added.
name - the simple name of the SarlBehavior.
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 SarlBehavior is attached.
See:
"TopElementBuilderFragment.java : appendTo : 1928"
getJvmDeclaredType
def getJvmDeclaredType : org.eclipse.xtext.common.types.JvmDeclaredType
Replies the JVM declared type for this generated SarlBehavior.
Returns:
the type, never null .
Since:
0.15
See:
"TopElementBuilderFragment.java : appendTo : 1893"
getSarlBehavior
def getSarlBehavior : SarlBehavior
Replies the generated SarlBehavior.
See:
"TopElementBuilderFragment.java : appendTo : 1798"
getSarlBehaviorReference
def getSarlBehaviorReference : 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
Replies the context for type resolution.
Returns:
the context or null if the Ecore object is the context.
See:
"TopElementBuilderFragment.java : appendTo : 1582"
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) : ISarlBehaviorBuilder
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) : ISarlBehaviorBuilder
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) : ISarlBehaviorBuilder
Change the super type.
Parameters:
superType - the super type, or null if the default type.
Returns:
this .
See:
"TopElementBuilderFragment.java : appendTo : 2085"