Class MethodSymbolSearch

java.lang.Object

org.ek9lang.compiler.search.SymbolSearch

org.ek9lang.compiler.search.MethodSymbolSearch

public final class MethodSymbolSearch
extends SymbolSearch

Quite a few option to a method search. In some cases you need to be exact but in others you want the return type left open. So there are multiple constructors to support this.

Constructor Summary

Constructors

Constructor	Description
MethodSymbolSearch(String name)
MethodSymbolSearch(String name, Optional<ISymbol> ofTypeOrReturn)
MethodSymbolSearch(String newName, SymbolSearch from)	Create a method search from an existing search, but with a new name.
MethodSymbolSearch(String name, ISymbol ofTypeOrReturn)
MethodSymbolSearch(String newName, MethodSymbol methodSymbol)	Create a method search given a method symbol, but used a new method name.§ But this does not set the expected type.
MethodSymbolSearch(SymbolSearch from)
MethodSymbolSearch(MethodSymbol methodSymbol)	Create a method search given a method symbol.

Method Summary

Modifier and Type	Method	Description
MethodSymbolSearch	addTypeParameter(Optional<ISymbol> parameter)	Add a type parameter to the search.
MethodSymbolSearch	addTypeParameter(ISymbol parameter)	Add a parameter to the search parameters.
MethodSymbolSearch	setOfTypeOrReturn(Optional<ISymbol> ofTypeOrReturn)	What type of symbol is being searched for or its return type.
MethodSymbolSearch	setOfTypeOrReturn(ISymbol ofTypeOrReturn)
MethodSymbolSearch	setTypeParameters(List<ISymbol> typeParameters)	Set any parameters that might be needed as part of this search.

Methods inherited from class SymbolSearch

cloneIntoSearchSymbol, getAsSymbol, getName, getOfTypeOrReturn, getSearchType, getTypeParameters, getValidSearchTypes, isAnyValidTypeSearch, isCategoryAcceptable, isLimitToBlocks, setExampleSymbolToMatch, setLimitToBlocks, setSearchType, setVetoSearchTypes, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MethodSymbolSearch

public MethodSymbolSearch(SymbolSearch from)

MethodSymbolSearch

public MethodSymbolSearch(String newName,
 SymbolSearch from)

Create a method search from an existing search, but with a new name.

MethodSymbolSearch

public MethodSymbolSearch(MethodSymbol methodSymbol)

Create a method search given a method symbol. But this does not set the expected type. This is very useful for finding overridden methods where the returning type is different but compatible.

MethodSymbolSearch

public MethodSymbolSearch(String newName,
 MethodSymbol methodSymbol)

Create a method search given a method symbol, but used a new method name.§ But this does not set the expected type. This is very useful for finding overridden methods where the returning type is different but compatible.

MethodSymbolSearch

public MethodSymbolSearch(String name)

MethodSymbolSearch

public MethodSymbolSearch(String name,
 Optional<ISymbol> ofTypeOrReturn)

MethodSymbolSearch

public MethodSymbolSearch(String name,
 ISymbol ofTypeOrReturn)

Method Details

setTypeParameters

public MethodSymbolSearch setTypeParameters(List<ISymbol> typeParameters)

Description copied from class: SymbolSearch

Set any parameters that might be needed as part of this search.

Overrides:

setTypeParameters in class SymbolSearch

addTypeParameter

public MethodSymbolSearch addTypeParameter(Optional<ISymbol> parameter)

Description copied from class: SymbolSearch

Add a type parameter to the search.

Overrides:

addTypeParameter in class SymbolSearch

addTypeParameter

public MethodSymbolSearch addTypeParameter(ISymbol parameter)

Description copied from class: SymbolSearch

Add a parameter to the search parameters. This is the 'type' symbol - i.e. Integer or whatever. It is not a variable that 'has' a type.

Overrides:

addTypeParameter in class SymbolSearch

setOfTypeOrReturn

public MethodSymbolSearch setOfTypeOrReturn(Optional<ISymbol> ofTypeOrReturn)

Description copied from class: SymbolSearch

What type of symbol is being searched for or its return type.

Overrides:

setOfTypeOrReturn in class SymbolSearch

setOfTypeOrReturn

public MethodSymbolSearch setOfTypeOrReturn(ISymbol ofTypeOrReturn)

Overrides:

setOfTypeOrReturn in class SymbolSearch