io.sarl.lang.codebuilder.builders
Interface IBlockExpressionBuilder
All Known Implementing Classes:
BlockExpressionSourceAppender, BlockExpressionBuilderImpl
interface IBlockExpressionBuilder
Builder of a Sarl XBlockExpression.
See:
"BlockExpressionBuilderFragment.java : appendTo : 112"
Property Summary
Modifier and type Property and description
java.lang.String autoGeneratedActionString
Replies the string for "auto-generated" comments.
org.eclipse.xtext.common.types.access.IJvmTypeProvider typeResolutionContext
Replies the context for type resolution.
org.eclipse.xtext.xbase.XBlockExpression xBlockExpression
An empty block expression.
Action Summary
Modifier and type Action and description
abstract IExpressionBuilder addExpression
Add an expression inside the block.
abstract void dispose
Dispose the resource.
abstract void eInit(IJvmTypeProvider)
Create the XBlockExpression.
abstract org.eclipse.emf.ecore.resource.Resource eResource
Replies the resource to which the XBlockExpression is attached.
abstract java.lang.String getAutoGeneratedActionString
Replies the string for "auto-generated" comments.
abstract java.lang.String getAutoGeneratedActionString(Resource)
Replies the string for "auto-generated" comments.
abstract org.eclipse.xtext.common.types.access.IJvmTypeProvider getTypeResolutionContext
Replies the context for type resolution.
abstract org.eclipse.xtext.xbase.XBlockExpression getXBlockExpression
An empty block expression.
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 IBlockExpressionBuilder setDefaultAutoGeneratedContent
Fill the block with the standard "auto-generated" content assuming that there is no value to return.
abstract IBlockExpressionBuilder setDefaultAutoGeneratedContent(String)
Fill the block with the standard "auto-generated" content.
abstract IBlockExpressionBuilder setDefaultAutoGeneratedContent(JvmTypeReference)
Fill the block with the standard "auto-generated" content.
abstract IBlockExpressionBuilder setInnerDocumentation(String)
Change the documentation of the element.
Property Details
autoGeneratedActionString
val autoGeneratedActionString : java.lang.String
Replies the string for "auto-generated" comments.

This property is an alias for the action: getAutoGeneratedActionString

Returns:
the comment text.
See:
"BlockExpressionBuilderFragment.java : appendTo : 489"
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:
"BlockExpressionBuilderFragment.java : appendTo : 422"
xBlockExpression
val xBlockExpression : org.eclipse.xtext.xbase.XBlockExpression
An empty block expression.

This property is an alias for the action: getXBlockExpression

Returns:
the block expression.
See:
"BlockExpressionBuilderFragment.java : appendTo : 571"
Action Details
addExpression
def addExpression : IExpressionBuilder
Add an expression inside the block.
Returns:
the expression builder.
See:
"BlockExpressionBuilderFragment.java : appendTo : 632"
dispose
def dispose
Dispose the resource.
See:
"BlockExpressionBuilderFragment.java : appendTo : 882"
eInit(IJvmTypeProvider)
def eInit(IJvmTypeProvider)
Create the XBlockExpression.
Parameters:
context - the context for type resolution.
See:
"BlockExpressionBuilderFragment.java : appendTo : 452"
eResource
def eResource : org.eclipse.emf.ecore.resource.Resource
Replies the resource to which the XBlockExpression is attached.
See:
"BlockExpressionBuilderFragment.java : appendTo : 600"
getAutoGeneratedActionString
def getAutoGeneratedActionString : java.lang.String
Replies the string for "auto-generated" comments.
Returns:
the comment text.
See:
"BlockExpressionBuilderFragment.java : appendTo : 489"
getAutoGeneratedActionString(Resource)
def getAutoGeneratedActionString(Resource) : java.lang.String
Replies the string for "auto-generated" comments.
Parameters:
resource - the resource for which the comment must be determined.
Returns:
the comment text.
See:
"BlockExpressionBuilderFragment.java : appendTo : 521"
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:
"BlockExpressionBuilderFragment.java : appendTo : 422"
getXBlockExpression
def getXBlockExpression : org.eclipse.xtext.xbase.XBlockExpression
An empty block expression.
Returns:
the block expression.
See:
"BlockExpressionBuilderFragment.java : appendTo : 571"
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:
"BlockExpressionBuilderFragment.java : appendTo : 266"
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:
"BlockExpressionBuilderFragment.java : appendTo : 356"
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:
"BlockExpressionBuilderFragment.java : appendTo : 294"
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:
"BlockExpressionBuilderFragment.java : appendTo : 324"
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 contet 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:
"BlockExpressionBuilderFragment.java : appendTo : 390"
setDefaultAutoGeneratedContent
def setDefaultAutoGeneratedContent : IBlockExpressionBuilder
Fill the block with the standard "auto-generated" content assuming that there is no value to return.

Any previously added content is removed.
Returns:
this
See:
"BlockExpressionBuilderFragment.java : appendTo : 826"
setDefaultAutoGeneratedContent(String)
def setDefaultAutoGeneratedContent(String) : IBlockExpressionBuilder
Fill the block with the standard "auto-generated" content.

Any previously added content is removed.
Parameters:
type - the expected type of the block (the last instruction), or null for no type.
Returns:
this
See:
"BlockExpressionBuilderFragment.java : appendTo : 698"
setDefaultAutoGeneratedContent(JvmTypeReference)
def setDefaultAutoGeneratedContent(JvmTypeReference) : IBlockExpressionBuilder
Fill the block with the standard "auto-generated" content.

Any previously added content is removed.
Parameters:
type - the expected type of the block (the last instruction), or null for no type.
Returns:
this
See:
"BlockExpressionBuilderFragment.java : appendTo : 764"
setInnerDocumentation(String)
def setInnerDocumentation(String) : IBlockExpressionBuilder
Change the documentation of the element.

getXBlockExpression()
Parameters:
doc - the documentation.
Returns:
this .
See:
"AbstractSubCodeBuilderFragment.java : appendTo : 603"