io.sarl.lang.codebuilder.builders
Interface ISarlInterfaceBuilder
All Known Implementing Classes:
SarlInterfaceSourceAppender, SarlInterfaceBuilderImpl
interface ISarlInterfaceBuilder
Builder of a Sarl SarlInterface.
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 SarlInterface.
SarlInterface sarlInterface
Replies the generated SarlInterface.
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 ISarlInterfaceBuilder addExtends(String)
Add the super type.
abstract ISarlInterfaceBuilder addExtends(JvmParameterizedTypeReference)
Add the super type.
abstract ISarlInterfaceBuilder 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 ISarlClassBuilder addSarlClass(String)
Create a SarlClass.
abstract ISarlEnumerationBuilder addSarlEnumeration(String)
Create a SarlEnumeration.
abstract ISarlFieldBuilder addSarlField(String)
Create a SarlField
abstract ISarlInterfaceBuilder addSarlInterface(String)
Create a SarlInterface.
abstract ITypeParameterBuilder addTypeParameter(String)
Add a type parameter.
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 void eInit(XtendTypeDeclaration,String,IJvmTypeProvider)
Initialize the Ecore element when inner type declaration.
abstract org.eclipse.emf.ecore.resource.Resource eResource
Replies the resource to which the SarlInterface is attached.
abstract org.eclipse.xtext.common.types.JvmDeclaredType getJvmDeclaredType
Replies the JVM declared type for this generated SarlInterface.
abstract SarlInterface getSarlInterface
Replies the generated SarlInterface.
abstract org.eclipse.xtext.common.types.JvmTypeReference getSarlInterfaceReference(JvmTypeReference*)
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 ISarlInterfaceBuilder 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 SarlInterface.

This property is an alias for the action: getJvmDeclaredType

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

This property is an alias for the action: getSarlInterface

See:
"TopElementBuilderFragment.java : appendTo : 1798"
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) : ISarlInterfaceBuilder
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) : ISarlInterfaceBuilder
Add the super type.
Parameters:
superType - the super type.
Returns:
this
See:
"TopElementBuilderFragment.java : appendTo : 2065"
addModifier(String)
def addModifier(String) : ISarlInterfaceBuilder
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"
addSarlClass(String)
def addSarlClass(String) : ISarlClassBuilder
Create a SarlClass.
Parameters:
name - the name of the SarlClass.
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"
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"
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 SarlInterface is added.
name - the simple name of the SarlInterface.
context - the context in which the resolution of types must be done.
See:
"TopElementBuilderFragment.java : appendTo : 1662"
eInit(XtendTypeDeclaration,String,IJvmTypeProvider)
def eInit(XtendTypeDeclaration,String,IJvmTypeProvider)
Initialize the Ecore element when inner type declaration.
Parameters:
container - the Ecore type that must contain this new SarlInterface.
name - the simple name of the SarlInterface.
context - the context in which the resolution of types must be done.
See:
"TopElementBuilderFragment.java : appendTo : 1741"
eResource
def eResource : org.eclipse.emf.ecore.resource.Resource
Replies the resource to which the SarlInterface is attached.
See:
"TopElementBuilderFragment.java : appendTo : 1928"
getJvmDeclaredType
def getJvmDeclaredType : org.eclipse.xtext.common.types.JvmDeclaredType
Replies the JVM declared type for this generated SarlInterface.
Returns:
the type, never null .
Since:
0.15
See:
"TopElementBuilderFragment.java : appendTo : 1893"
getSarlInterface
def getSarlInterface : SarlInterface
Replies the generated SarlInterface.
See:
"TopElementBuilderFragment.java : appendTo : 1798"
getSarlInterfaceReference(JvmTypeReference*)
def getSarlInterfaceReference(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
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) : ISarlInterfaceBuilder
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"