Package jetbrains.mps.core.aspects.behaviour.api

Interface SMethod<T>

All Superinterfaces:

SElement, SExecutable, SNamedElement

All Known Implementing Classes:

SMethodImpl

public interface SMethod<T>
extends SExecutable

Represents a behavior method for a given SAbstractConcept It has a SMethodId which uniquely identifies the instance of SMethod. The current contract is that two SMethod are equal as soon as their ids are equal. The supposed way to call behavior methods is as follows. If it is possible to get SMethod directly (from the generated fields of BHDescriptor) then one needs to take the method from there and invoke it via invoke(org.jetbrains.mps.openapi.model.SNode, java.lang.Object...) or invokeSpecial(org.jetbrains.mps.openapi.model.SNode, java.lang.Object...) or others. If it is not possible then one needs to get method by reflection from the BHDescriptor (via #getMethod). Currently there are handy invocation methods in the BHReflection facade. T -- java runtime return type (for compile-time checking)

See Also:

BHDescriptor

Method Summary

Modifier and Type	Method	Description
SMethodId	getId()
SAbstractType	getReturnType()
T	invoke(SAbstractConcept operand, Object... parameters)	invokes the method in the case it is static (trying to resolve the right method on runtime if it is virtual)
T	invoke(SNode operand, Object... parameters)	invokes the method (trying to resolve the right method on runtime if it is virtual) essentially invokes the #invoke0 method with the concept of the operand
T	invoke0(SAbstractConcept operand, SAbstractConcept concreteConcept, Object... parameters)
T	invoke0(SNode operand, SAbstractConcept concreteConcept, Object... parameters)	invokes the virtual method as if applied to the node of the concreteConcept
T	invokeSpecial(SAbstractConcept operand, Object... parameters)	invokes private method (no dynamic method resolve)
T	invokeSpecial(SNode operand, Object... parameters)	invokes private method (no dynamic method resolve) generated from the super non-virtual invocations or the super<> invocations
T	invokeSuper(SAbstractConcept operand, SAbstractConcept concreteConcept, Object... parameters)	invokes virtual method looking for the ancestors of the concept (dynamic method resolve)
T	invokeSuper(SNode operand, SAbstractConcept concreteConcept, Object... parameters)	invokes virtual method looking for the ancestors of the node's concept (dynamic method resolve)
boolean	isAbstract()	abstract => virtual
boolean	isStatic()
boolean	isVirtual()

Methods inherited from interface org.jetbrains.mps.openapi.language.SElement

getLanguage, getSourceNode

Methods inherited from interface jetbrains.mps.core.aspects.behaviour.api.SExecutable

getConcept, getExceptions, getModifiers, getParameters

Methods inherited from interface org.jetbrains.mps.openapi.language.SNamedElement

getName

Method Detail

getId

@NotNull
SMethodId getId()

Returns:

SMethodId which uniquely identifies the behavior methods within the concept NB: all inherited methods count as well However the id of the virtual method and its overrides is the same (!)

getReturnType

@NotNull
SAbstractType getReturnType()

Returns:

the return type of the SMethod

invoke

T invoke(@Nullable
         SNode operand,
         Object... parameters)

invokes the method (trying to resolve the right method on runtime if it is virtual) essentially invokes the #invoke0 method with the concept of the operand

invoke

T invoke(@Nullable
         SAbstractConcept operand,
         Object... parameters)

invokes the method in the case it is static (trying to resolve the right method on runtime if it is virtual)

invoke0

T invoke0(@Nullable
          SNode operand,
          @NotNull
          SAbstractConcept concreteConcept,
          Object... parameters)

invokes the virtual method as if applied to the node of the concreteConcept

invoke0

T invoke0(@Nullable
          SAbstractConcept operand,
          @NotNull
          SAbstractConcept concreteConcept,
          Object... parameters)

invokeSpecial

T invokeSpecial(@Nullable
                SNode operand,
                Object... parameters)

invokes private method (no dynamic method resolve) generated from the super non-virtual invocations or the super<> invocations

invokeSpecial

T invokeSpecial(@Nullable
                SAbstractConcept operand,
                Object... parameters)

invokes private method (no dynamic method resolve)

invokeSuper

T invokeSuper(@Nullable
              SNode operand,
              @NotNull
              SAbstractConcept concreteConcept,
              Object... parameters)

invokes virtual method looking for the ancestors of the node's concept (dynamic method resolve)

Parameters:

concreteConcept - is the concept from which the #invokeSuper is intended to be executed

invokeSuper

T invokeSuper(@Nullable
              SAbstractConcept operand,
              @NotNull
              SAbstractConcept concreteConcept,
              Object... parameters)

invokes virtual method looking for the ancestors of the concept (dynamic method resolve)

Parameters:

concreteConcept - is the concept from which the #invokeSuper is intended to be executed

isVirtual

boolean isVirtual()

Returns:

true iff the method has a virtual modifier

See Also:

SExecutable.getModifiers()

isAbstract

boolean isAbstract()

abstract => virtual

Returns:

true iff the method has an abstract modifier

isStatic

boolean isStatic()

Returns:

true iff the method has a static modifier

See Also:

SExecutable.getModifiers()