FunctionSignature (LSPS 3.3 SDK)

java.lang.Object
- com.whitestein.lsps.lang.signature.FunctionSignature

All Implemented Interfaces:

LangElement, Cloneable
```
public final class FunctionSignature
extends Object
implements LangElement, Cloneable
```
Function signature class contains name, parameters, and implementation of a function.

Author:

pna, vbu, rba

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FunctionSignature.Builder
Builder class for FunctionSignature.

Nested Classes
Modifier and Type	Class and Description
`static class`	`FunctionSignature.Builder` Builder class for `FunctionSignature`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`appendArgumentTypeList(StringBuilder sb)` Appends argument type list with parenthesis.
`void`	`appendFreeTypeList(StringBuilder sb)` Appends a free type list e.g.
`static FunctionSignature.Builder`	`builder(String name)` Returns builder to build the function signature.
`FunctionSignature`	`clone()`
`int`	`getArgumentCount()` Returns the number of input parameters.
`String`	`getArgumentName(int i)` Returns i-th argument name.
`String`	`getArgumentNameList()` Returns a argument name list in parentheses e.g.
`Type`	`getArgumentType(int i)` Returns i-th type.
`Type`	`getArgumentType(String argName)` Returns the argument type for a given argument name.
`String`	`getArgumentTypeList()` Returns a argument type list in parentheses e.g.
`String`	`getArgumentTypeNameList()` Returns a argument type and name list in parentheses e.g.
`Type`	`getArgumentTypeVariadic(int i)` Returns i-th argument type considering also variadic arguments.
`ClosureType`	`getClosureType()` Returns the corresponding closure type.
`ClosureType`	`getClosureType(int argCount)` Returns the corresponding closure type.
`FunctionConstraint`	`getConstraint()` Returns the function constraint.
`Object`	`getData()` Returns the data.
`String`	`getDefinition()` Returns the textual definition of the signature.
`int`	`getFixedArgumentCount()` Returns the number of fixed input paramters.
`Type`	`getFreeTypeBound(FreeType freeType)` Returns the free type upper bound, or `null` if there is no bound defined.
`Map<FreeType,Type>`	`getFreeTypeBounds()`
`List<FreeType>`	`getFreeTypes()` Returns the free types of this function.
`List<Class<?>>`	`getJavaArgumentTypes()` Returns list of argument types then compiled to java.
`Map<String,String>`	`getMetadata()` Returns the metadata of this function
`String`	`getMetadata(String key)` Returns the metadata value for a given key.
`Set<Modifier>`	`getModifiers()` Deprecated. Use getter for each modifier
`String`	`getName()` Returns the name of this function.
`NamespaceModel`	`getNamespaceModel()` Returns the owner namespace model.
`Operation`	`getOperation()` Returns the operation that executes this method
`QID`	`getQID()` Returns `QID` for this signature.
`Type`	`getReturnType()` Returns the return type of this block.
`SignatureParameter`	`getSignatureParameter(int i)` Returns i-th signature parameter.
`List<SignatureParameter>`	`getSignatureParameters()` Returns signature parameters
`String`	`getSignatureString()` Returns string representing this signature.
`Visibility`	`getVisibility()` Returns the signature visibility.
`boolean`	`hasMetadata(String key)` Returns `true` if this function has the metadata key.
`boolean`	`isAbstract()` Returns `true` if this method is abstract.
`boolean`	`isClassMember()` Returns true if it is class member (method or constructor).
`boolean`	`isCompiled()` Returns true if function should be compiled to java.
`boolean`	`isConstructor()` Returns true if this is a constructor.
`boolean`	`isDeprecated()` Returns true if the function is deprecated.
`boolean`	`isExtensionMethod()` Returns true if the function is an extension method.
`boolean`	`isMethod()` Returns true if it is method.
`boolean`	`isPrivate()` Returns true if the function signature is private.
`boolean`	`isProtected()` Returns true if the function signature is protected.
`boolean`	`isPublic()` Returns true if the function signature is public.
`boolean`	`isSame(FunctionSignature signature)` Returns true if this signature is same as the other one.
`boolean`	`isSideEffect()` Returns true if the function has side effects.
`boolean`	`isStatic()` Returns whether the function is a static method of its namespace.
`boolean`	`isVariadic()` Returns true if the signature is variadic.
`SignatureMapping`	`match(int argCount, Type type)` Returns mapping of the free types in this function signature such that the resulting closure type is the most general type which is subtype of `type` or null if such mapping does not exist.
`SignatureMapping`	`match(Type returnType, Map<String,Type> args)` Returns mapping of the free types in this function signature to provided actual named parameter types; or `null` if such mapping is not possible.
`SignatureMapping`	`match(Type returnType, Type... actualTypes)` Returns mapping of the free types in this function signature to provided actual parameter types; or null if such mapping is not possible.
`void`	`setData(Object data)` Sets the data.
`void`	`setNamespaceModel(NamespaceModel namespaceModel)` Sets the owner namespace model.
`void`	`setOperation(Operation operation)` Sets the operation that executes this method.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getOperation
```
public Operation getOperation()
```
    Returns the operation that executes this method
    
    Returns:
    
    the operation that executes this method
  - setOperation
```
public void setOperation(Operation operation)
```
    Sets the operation that executes this method. This can be called only once, if the operation is already set, IllegalStateException is thrown.
    
    Parameters:
    
    operation -
    
    Throws:
    
    IllegalStateException - if the operation is already set
  - getName
```
public String getName()
```
    Returns the name of this function.
    
    Specified by:
    
    getName in interface LangElement
    
    Returns:
    
    the name of this function
  - getFreeTypes
```
public List<FreeType> getFreeTypes()
```
    Returns the free types of this function.
    
    Returns:
    
    the free types of this function
  - getConstraint
```
public FunctionConstraint getConstraint()
```
    Returns the function constraint.
    
    Returns:
    
    the function constraint
  - getMetadata
```
public Map<String,String> getMetadata()
```
    Returns the metadata of this function
    
    Specified by:
    
    getMetadata in interface LangElement
    
    Returns:
    
    the metadata of this function
  - getMetadata
```
public String getMetadata(String key)
```
    Returns the metadata value for a given key.
    
    Specified by:
    
    getMetadata in interface LangElement
    
    Parameters:
    
    key -
    
    Returns:
    
    the metadata value
  - hasMetadata
```
public boolean hasMetadata(String key)
```
    Returns true if this function has the metadata key.
    
    Specified by:
    
    hasMetadata in interface LangElement
    
    Parameters:
    
    key -
    
    Returns:
    
    true if this function has the metadata key
  - getFreeTypeBound
```
public Type getFreeTypeBound(FreeType freeType)
```
    Returns the free type upper bound, or null if there is no bound defined.
    
    Parameters:
    
    freeType -
    
    Returns:
    
    the free type bound
  - getFreeTypeBounds
```
public Map<FreeType,Type> getFreeTypeBounds()
```
    Returns:
    
    the map of free type bounds
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getSignatureString
```
public String getSignatureString()
```
    Returns string representing this signature.
    
    Returns:
    
    string representing this signature
  - getQID
```
public QID getQID()
```
    Returns QID for this signature.
    
    Returns:
    
    QID for this signature
  - appendFreeTypeList
```
public void appendFreeTypeList(StringBuilder sb)
```
    Appends a free type list e.g. . Free type bounds are not appended. If the signature has no free types, nothing is appended.
    
    Parameters:
    
    sb -
  - getArgumentTypeList
```
public String getArgumentTypeList()
```
    Returns a argument type list in parentheses e.g. (String, Integer)
    
    Returns:
    
    the argument type list string
  - appendArgumentTypeList
```
public void appendArgumentTypeList(StringBuilder sb)
```
    Appends argument type list with parenthesis.
    
    Parameters:
    
    sb -
  - getArgumentNameList
```
public String getArgumentNameList()
```
    Returns a argument name list in parentheses e.g. (arg0, arg1)
    
    Returns:
    
    the argument name list string
  - getArgumentTypeNameList
```
public String getArgumentTypeNameList()
```
    Returns a argument type and name list in parentheses e.g. (Object arg0, String arg1)
    
    Returns:
    
    the argument type and name list string
  - isStatic
```
public boolean isStatic()
```
    Returns whether the function is a static method of its namespace.
    
    Returns:
    
    true if function is defined as static
  - getVisibility
```
public Visibility getVisibility()
```
    Returns the signature visibility.
    
    Returns:
    
    the signature visibility
  - isPublic
```
public boolean isPublic()
```
    Returns true if the function signature is public.
    
    Returns:
    
    true if the function signature is public
  - isPrivate
```
public boolean isPrivate()
```
    Returns true if the function signature is private.
    
    Returns:
    
    true if the function signature is private
  - isProtected
```
public boolean isProtected()
```
    Returns true if the function signature is protected.
    
    Returns:
    
    true if the function signature is protected
  - isDeprecated
```
public boolean isDeprecated()
```
    Returns true if the function is deprecated.
    
    Returns:
    
    true if the function is deprecated
  - isSideEffect
```
public boolean isSideEffect()
```
    Returns true if the function has side effects.
    
    Returns:
    
    true if the function has side effects
  - isExtensionMethod
```
public boolean isExtensionMethod()
```
    Returns true if the function is an extension method.
    
    Returns:
    
    true if the function is an extension method
  - getModifiers
```
@Deprecated
public Set<Modifier> getModifiers()
```
    Deprecated. Use getter for each modifier
    
    Returns unmodifiable set of function signature modifiers.
    
    Returns:
    
    set of function signature modifiers
  - getData
```
public Object getData()
```
    Returns the data.
    
    Specified by:
    
    getData in interface LangElement
    
    Returns:
    
    the data
  - setData
```
public void setData(Object data)
```
    Sets the data.
    
    Parameters:
    
    data -
  - getNamespaceModel
```
public NamespaceModel getNamespaceModel()
```
    Returns the owner namespace model.
    
    Returns:
    
    the owner namespace model
  - setNamespaceModel
```
public void setNamespaceModel(NamespaceModel namespaceModel)
```
    Sets the owner namespace model.
    
    Parameters:
    
    namespaceModel -
  - builder
```
public static FunctionSignature.Builder builder(String name)
```
    Returns builder to build the function signature.
    
    Parameters:
    
    name - function name
    
    Returns:
    
    builder to build the function signature
  - match
```
public SignatureMapping match(Type returnType,
                              Type... actualTypes)
```
    Returns mapping of the free types in this function signature to provided actual parameter types; or null if such mapping is not possible.
    
    Parameters:
    
    returnType -
    
    actualTypes - actual types of parameters of the function
    
    Returns:
    
    mapping of signature free types to actual parameter types
  - match
```
public SignatureMapping match(int argCount,
                              Type type)
```
    Returns mapping of the free types in this function signature such that the resulting closure type is the most general type which is subtype of type or null if such mapping does not exist.
    
    Parameters:
    
    argCount -
    
    type -
    
    Returns:
    
    mapping of the free types
    
    Throws:
    
    NullPointerException - if type is null.
  - match
```
public SignatureMapping match(Type returnType,
                              Map<String,Type> args)
```
    Returns mapping of the free types in this function signature to provided actual named parameter types; or null if such mapping is not possible.
    
    Parameters:
    
    returnType -
    
    args -
    
    Returns:
    
    a mapping of free types
  - isSame
```
public boolean isSame(FunctionSignature signature)
```
    Returns true if this signature is same as the other one. This means that the names are the equal, the argument count are equal and argument types are equal.
    
    Parameters:
    
    signature - signature to compare with
    
    Returns:
    
    true iff this signature is equivalent to the other one
  - getArgumentTypeVariadic
```
public Type getArgumentTypeVariadic(int i)
```
    Returns i-th argument type considering also variadic arguments.
    
    Parameters:
    
    i -
    
    Returns:
    
    i-th argument type considering also variadic arguments
  - getArgumentCount
```
public int getArgumentCount()
```
    Returns the number of input parameters.
    
    Returns:
    
    number of input parameters
  - getFixedArgumentCount
```
public int getFixedArgumentCount()
```
    Returns the number of fixed input paramters. For non-variadic functions it is the argument count, for variadic functions it is the argument count - 1.
    
    Returns:
    
    the number of fixed input paramters
  - getSignatureParameter
```
public SignatureParameter getSignatureParameter(int i)
```
    Returns i-th signature parameter.
    
    Parameters:
    
    i -
    
    Returns:
    
    i-th signature parameter
    
    Throws:
    
    IllegalArgumentException - if i is out of bounds
  - getArgumentType
```
public Type getArgumentType(int i)
```
    Returns i-th type.
    
    Parameters:
    
    i -
    
    Returns:
    
    i-th type
    
    Throws:
    
    IllegalArgumentException - if i is out of bounds
  - getArgumentName
```
public String getArgumentName(int i)
```
    Returns i-th argument name.
    
    Parameters:
    
    i -
    
    Returns:
    
    i-th argument name
    
    Throws:
    
    IllegalArgumentException - if i is out of bounds
  - getReturnType
```
public Type getReturnType()
```
    Returns the return type of this block.
    
    Returns:
    
    type returned by this block
  - isVariadic
```
public boolean isVariadic()
```
    Returns true if the signature is variadic.
    
    Returns:
    
    true if the signature is variadic
  - getClosureType
```
public ClosureType getClosureType(int argCount)
```
    Returns the corresponding closure type. The parameter argCount determines argument count when the signature is variadic, if it is not, it must be the argument count.
    
    Parameters:
    
    argCount -
    
    Returns:
    
    the corresponding closure type
    
    Throws:
    
    IllegalArgumentException - if argCount is invalid
  - getClosureType
```
public ClosureType getClosureType()
```
    Returns the corresponding closure type. If the signature is variadic, the last argument of the closure is a list type of the last signature argument.
    
    Returns:
    
    the corresponding closure type
  - getSignatureParameters
```
public List<SignatureParameter> getSignatureParameters()
```
    Returns signature parameters
    
    Returns:
    
    signature parameters
  - clone
```
public FunctionSignature clone()
```
    Overrides:
    
    clone in class Object
  - getArgumentType
```
public Type getArgumentType(String argName)
```
    Returns the argument type for a given argument name.
    
    Parameters:
    
    argName - the argument name
    
    Returns:
    
    the argument type
  - isMethod
```
public boolean isMethod()
```
    Returns true if it is method.
    
    Returns:
    
    true if it is method
  - isConstructor
```
public boolean isConstructor()
```
    Returns true if this is a constructor.
    
    Returns:
    
    true if this is a constructor
  - isClassMember
```
public boolean isClassMember()
```
    Returns true if it is class member (method or constructor).
    
    Returns:
    
    true if it is class member
  - isAbstract
```
public boolean isAbstract()
```
    Returns true if this method is abstract.
    
    Returns:
    
    true if this method is abstract
  - isCompiled
```
public boolean isCompiled()
```
    Returns true if function should be compiled to java.
    
    Returns:
    
    true if function should be compiled to java
  - getJavaArgumentTypes
```
public List<Class<?>> getJavaArgumentTypes()
```
    Returns list of argument types then compiled to java.
    
    Returns:
    
    list of argument types then compiled to java
  - getDefinition
```
public String getDefinition()
```
    Returns the textual definition of the signature.
    
    Returns:
    
    the textual signature definition

Class FunctionSignature

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getOperation

setOperation

getName

getFreeTypes

getConstraint

getMetadata

getMetadata

hasMetadata

getFreeTypeBound

getFreeTypeBounds

toString

getSignatureString

getQID

appendFreeTypeList

getArgumentTypeList

appendArgumentTypeList

getArgumentNameList

getArgumentTypeNameList

isStatic

getVisibility

isPublic

isPrivate

isProtected

isDeprecated

isSideEffect

isExtensionMethod

getModifiers

getData

setData

getNamespaceModel

setNamespaceModel

builder

match

match

match

isSame

getArgumentTypeVariadic

getArgumentCount

getFixedArgumentCount

getSignatureParameter

getArgumentType

getArgumentName

getReturnType

isVariadic

getClosureType

getClosureType

getSignatureParameters

clone

getArgumentType

isMethod

isConstructor

isClassMember

isAbstract

isCompiled

getJavaArgumentTypes

getDefinition