io.sarl.lang.codebuilder.appenders
Class SarlSkillSourceAppender
All Superinterfaces:
ISarlSkillBuilder
class SarlSkillSourceAppender
extends AbstractSourceAppender
implements ISarlSkillBuilder
Source adapter of a Sarl SarlSkill.
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 SarlSkill.
SarlSkill sarlSkill
Replies the generated SarlSkill.
org.eclipse.xtext.common.types.JvmTypeReference sarlSkillReference
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(ISarlSkillBuilder)
Action Summary
Modifier and type Action and description
ISarlActionBuilder addDefSarlAction(String)
Create a SarlAction.
ISarlSkillBuilder addImplements(String)
Add an implemented type.
ISarlSkillBuilder addImplements(JvmTypeReference)
Add an implemented type.
ISarlSkillBuilder addModifier(String)
Add a modifier.
ISarlActionBuilder addOverrideSarlAction(String)
Create a SarlAction.
ISarlActionBuilder addSarlAction(String)
Create a SarlAction
ISarlAnnotationTypeBuilder addSarlAnnotationType(String)
Create a SarlAnnotationType.
ISarlBehaviorUnitBuilder addSarlBehaviorUnit(String)
Create a SarlBehaviorUnit.
ISarlBehaviorUnitBuilder addSarlBehaviorUnit(JvmParameterizedTypeReference)
Create a SarlBehaviorUnit.
ISarlSkillBuilder addSarlCapacityUses(String*)
Create a SarlCapacityUses.
ISarlSkillBuilder addSarlCapacityUses(JvmParameterizedTypeReference*)
Create a SarlCapacityUses.
ISarlClassBuilder addSarlClass(String)
Create a SarlClass.
ISarlConstructorBuilder addSarlConstructor
Create a SarlConstructor.
ISarlEnumerationBuilder addSarlEnumeration(String)
Create a SarlEnumeration.
ISarlFieldBuilder addSarlField(String)
Create a SarlField
ISarlInterfaceBuilder addSarlInterface(String)
Create a SarlInterface.
ISarlSkillBuilder addSarlRequiredCapacity(String*)
Create a SarlRequiredCapacity.
ISarlSkillBuilder addSarlRequiredCapacity(JvmParameterizedTypeReference*)
Create a SarlRequiredCapacity.
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 SarlSkill is attached.
org.eclipse.xtext.common.types.JvmDeclaredType getJvmDeclaredType
Replies the JVM declared type for this generated SarlSkill.
SarlSkill getSarlSkill
Replies the generated SarlSkill.
org.eclipse.xtext.common.types.JvmTypeReference getSarlSkillReference
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.
ISarlSkillBuilder setDocumentation(String)
Change the documentation of the element.
ISarlSkillBuilder setExtends(String)
Change the super type.
ISarlSkillBuilder 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 SarlSkill.

This property is an alias for the action: getJvmDeclaredType

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

This property is an alias for the action: getSarlSkill

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

This property is an alias for the action: getSarlSkillReference

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(ISarlSkillBuilder)
new(ISarlSkillBuilder)
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"
addImplements(String)
def addImplements(String) : ISarlSkillBuilder
Add an implemented type.
Parameters:
type - the qualified name of the implemented type.
Returns:
this
See:
"TopElementBuilderFragment.java : appendTo : 2197"
addImplements(JvmTypeReference)
def addImplements(JvmTypeReference) : ISarlSkillBuilder
Add an implemented type.
Parameters:
type - the implemented type.
Returns:
this
See:
"TopElementBuilderFragment.java : appendTo : 2294"
addModifier(String)
def addModifier(String) : ISarlSkillBuilder
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*) : ISarlSkillBuilder
Create a SarlCapacityUses.
Parameters:
name - the types referenced by the SarlCapacityUses.
Returns:
this .
See:
"TopElementBuilderFragment.java : appendTo : 1041"
addSarlCapacityUses(JvmParameterizedTypeReference*)
def addSarlCapacityUses(JvmParameterizedTypeReference*) : ISarlSkillBuilder
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*) : ISarlSkillBuilder
Create a SarlRequiredCapacity.
Parameters:
name - the types referenced by the SarlRequiredCapacity.
Returns:
this .
See:
"TopElementBuilderFragment.java : appendTo : 1041"
addSarlRequiredCapacity(JvmParameterizedTypeReference*)
def addSarlRequiredCapacity(JvmParameterizedTypeReference*) : ISarlSkillBuilder
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"
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 SarlSkill is added.
name - the simple name of the SarlSkill.
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 SarlSkill is attached.
See:
"TopElementBuilderFragment.java : appendTo : 1928"
getJvmDeclaredType
def getJvmDeclaredType : org.eclipse.xtext.common.types.JvmDeclaredType
Replies the JVM declared type for this generated SarlSkill.
Returns:
the type, never null .
Since:
0.15
See:
"TopElementBuilderFragment.java : appendTo : 1893"
getSarlSkill
def getSarlSkill : SarlSkill
Replies the generated SarlSkill.
See:
"TopElementBuilderFragment.java : appendTo : 1798"
getSarlSkillReference
def getSarlSkillReference : 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) : ISarlSkillBuilder
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) : ISarlSkillBuilder
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) : ISarlSkillBuilder
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"