io.sarl.lang.codebuilder.builders
Interface ISarlCapacityBuilder
All Known Implementing Classes:
SarlCapacitySourceAppender, SarlCapacityBuilderImpl
interface ISarlCapacityBuilder
Builder of a Sarl SarlCapacity.
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 SarlCapacity.
SarlCapacity sarlCapacity
Replies the generated SarlCapacity.
org.eclipse.xtext.common.types.JvmTypeReference sarlCapacityReference
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 ISarlCapacityBuilder addExtends(String)
Add the super type.
abstract ISarlCapacityBuilder addExtends(JvmParameterizedTypeReference)
Add the super type.
abstract ISarlCapacityBuilder addModifier(String)
Add a modifier.
abstract ISarlActionBuilder addOverrideSarlAction(String)
Create a SarlAction.
abstract ISarlActionBuilder addSarlAction(String)
Create a SarlAction
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 SarlCapacity is attached.
abstract org.eclipse.xtext.common.types.JvmDeclaredType getJvmDeclaredType
Replies the JVM declared type for this generated SarlCapacity.
abstract SarlCapacity getSarlCapacity
Replies the generated SarlCapacity.
abstract org.eclipse.xtext.common.types.JvmTypeReference getSarlCapacityReference
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 ISarlCapacityBuilder setDocumentation(String)
Change the documentation of the element.
Property Details
jvmDeclaredType
val jvmDeclaredType : org.eclipse.xtext.common.types.JvmDeclaredType
Replies the JVM declared type for this generated SarlCapacity.

This property is an alias for the action: getJvmDeclaredType

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

This property is an alias for the action: getSarlCapacity

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

This property is an alias for the action: getSarlCapacityReference

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"
addExtends(String)
def addExtends(String) : ISarlCapacityBuilder
Add the super type.
Parameters:
superType - the qualified name of the super type.
Returns:
this
See:
"TopElementBuilderFragment.java : appendTo : 1966"
addExtends(JvmParameterizedTypeReference)
def addExtends(JvmParameterizedTypeReference) : ISarlCapacityBuilder
Add the super type.
Parameters:
superType - the super type.
Returns:
this
See:
"TopElementBuilderFragment.java : appendTo : 2065"
addModifier(String)
def addModifier(String) : ISarlCapacityBuilder
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"
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 SarlCapacity is added.
name - the simple name of the SarlCapacity.
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 SarlCapacity is attached.
See:
"TopElementBuilderFragment.java : appendTo : 1928"
getJvmDeclaredType
def getJvmDeclaredType : org.eclipse.xtext.common.types.JvmDeclaredType
Replies the JVM declared type for this generated SarlCapacity.
Returns:
the type, never null .
Since:
0.15
See:
"TopElementBuilderFragment.java : appendTo : 1893"
getSarlCapacity
def getSarlCapacity : SarlCapacity
Replies the generated SarlCapacity.
See:
"TopElementBuilderFragment.java : appendTo : 1798"
getSarlCapacityReference
def getSarlCapacityReference : 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) : ISarlCapacityBuilder
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"