com.github.aliteralmind.codelet.simplesig

Class SimpleParamSigSearchTerm

java.lang.Object

com.github.aliteralmind.codelet.simplesig.SimpleParamSigSearchTerm

Direct Known Subclasses:

ConstructorParamSearchTerm, MethodSigSearchTerm

public abstract class SimpleParamSigSearchTerm
extends Object

For matching a simple-parameter-name signatures with wildcards ('*'), indicating one or more of any parameter type.

Since:

0.1.0

Author:

Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com), dual-licensed under the LGPL (version 3.0 or later) or the ASL (version 2.0). See source code for details. http://codelet.aliteralmind.com, https://github.com/aliteralmind/codelet

See Also:

Real world use in Codelet

Constructor Summary

Constructors

Constructor and Description
SimpleParamSigSearchTerm(String search_termSig, Appendable debugBasics_ifNonNull, Appendable dbgDoesMatch_ifNonNull) Create a search term.

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	appendToString(StringBuilder to_appendTo) The original shortcut as provided to the constructor, with a single space following each comma.
boolean	doesMatch(SimpleParamNameSignature actual_cnstrMthd) Does a constructor/method match?.
protected boolean	doesMatchAnyProt(List<? extends SimpleParamNameSignature> to_searchList) Does any constructor/method match?.
protected boolean	doesMatchOnlyOneProt(List<? extends SimpleParamNameSignature> to_searchList) Does exactly one constructor/method match?.
protected List<? extends SimpleParamNameSignature>	getAllMatchesProt(List<? extends SimpleParamNameSignature> to_searchList, CrashIfZero crashIf_zero) Get a new list of all matching constructors/methods.
TextAppenter	getDebugAptrBasics()
TextAppenter	getDebugAptrDoesMatch()
protected SimpleParamNameSignature	getFirstMatchProt(List<? extends SimpleParamNameSignature> to_searchList, CrashIfZero crashIf_zero, CrashIfMoreThanOne crashIf_moreThanOne) Get the first matching constructor/method.
String	getMethodName() The function name, or the empty string if a constructor.
String	getNoParams() The original search-term parameter list, excluding the parentheses.
protected SimpleParamNameSignature	getOnlyMatchProt(List<? extends SimpleParamNameSignature> to_searchList) Get the first and only match.
List<String>	getTermList() Immutable list of parameter types (their simple names), where asterisks are replaced with null.
String	getWithParams() The original search-term parameter list.
boolean	hasAStar() Is there an asterisk anywhere in the parameter list?.
int	indexOfStar()
int	lastIndexOfStar()
void	setDebug(Appendable debugBasics_ifNonNull, Appendable dbgDoesMatch_ifNonNull)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleParamSigSearchTerm

public SimpleParamSigSearchTerm(String search_termSig,
                        Appendable debugBasics_ifNonNull,
                        Appendable dbgDoesMatch_ifNonNull)

Create a search term.

Parameters:

search_termSig - May not be null, must contain parentheses with zero or more parameters, and may contain a function name before the open paren ('('). When provided, the function name must be a valid Java identifier. Multiple parameters are separated by commas, and each is either

• The simple name of the parameter's Java type, with optional array indicators ("[]") or, in the last parameter only, ellipses ("...") (examples: "int", "String", "AClass"), "boolean[]", "String..."), or
• An asterisk ('*'), indicating one or more of any type. Two asterisks in a row are not permissible.

The final character must be the close paren (')'). Get with appendToString.

Method Detail

setDebug

public void setDebug(Appendable debugBasics_ifNonNull,
            Appendable dbgDoesMatch_ifNonNull)

getDebugAptrBasics

public TextAppenter getDebugAptrBasics()

getDebugAptrDoesMatch

public TextAppenter getDebugAptrDoesMatch()

getMethodName

public String getMethodName()

The function name, or the empty string if a constructor.

getTermList

public List<String> getTermList()

Immutable list of parameter types (their simple names), where asterisks are replaced with null.

See Also:

SimpleParamSigSearchTerm(String, Appendable, Appendable)

getWithParams

public String getWithParams()

The original search-term parameter list.

Returns:

The original search-term list, surrounded by parentheses, with one space following each comma.

See Also:

getNoParams()

getNoParams

public String getNoParams()

The original search-term parameter list, excluding the parentheses.

See Also:

getWithParams()

hasAStar

public boolean hasAStar()

Is there an asterisk anywhere in the parameter list?.

See Also:

getTermList(), SimpleParamSigSearchTerm(String, Appendable, Appendable)

doesMatchAnyProt

protected boolean doesMatchAnyProt(List<? extends SimpleParamNameSignature> to_searchList)

Does any constructor/method match?.

Returns:

(getFirstMatchProt(to_searchList, crashIf_zero, crashIf_moreThanOne) != null)

See Also:

getAllMatchesProt(List, CrashIfZero)

doesMatchOnlyOneProt

protected boolean doesMatchOnlyOneProt(List<? extends SimpleParamNameSignature> to_searchList)

Does exactly one constructor/method match?.

Returns:

(matchList != null && matchList.size() == 1)
Where matchList is
getAllMatchesProt(to_searchList, CrashIfZero.NO)

See Also:

getOnlyMatchProt(List)

getAllMatchesProt

protected List<? extends SimpleParamNameSignature> getAllMatchesProt(List<? extends SimpleParamNameSignature> to_searchList,
                                                         CrashIfZero crashIf_zero)

Get a new list of all matching constructors/methods.

Parameters:

to_searchList - The actually-existing constructors/methods to search. May not be null.

crashIf_zero - If com.github.xbn.lang.reflect.CrashIfZero#YES YES, then zero matches is unacceptable. May not be null.

Returns:

A new and mutable list containing all matching constructors/methods, or null if no messages match.

Throws:

RTNoSuchMethodException - If zero matches and crashIf_zero is YES.

See Also:

getFirstMatchProt(List, CrashIfZero, CrashIfMoreThanOne)

getOnlyMatchProt

protected SimpleParamNameSignature getOnlyMatchProt(List<? extends SimpleParamNameSignature> to_searchList)

Get the first and only match.

Returns:

getFirstMatchProt(to_searchList, CrashIfZero.YES, CrashIfMoreThanOne.YES)

See Also:

getAllMatchesProt

getFirstMatchProt

protected SimpleParamNameSignature getFirstMatchProt(List<? extends SimpleParamNameSignature> to_searchList,
                                         CrashIfZero crashIf_zero,
                                         CrashIfMoreThanOne crashIf_moreThanOne)

Get the first matching constructor/method.

Parameters:

to_searchList - The actually-existing constructor/methods to search. May not be null.

crashIf_zero - If com.github.xbn.lang.reflect.CrashIfZero#YES YES, then zero matches is unacceptable. May not be null.

crashIf_moreThanOne - If com.github.xbn.lang.reflect.CrashIfMoreThanOne#YES YES, then more than one match is unacceptable. May not be null.

Returns:

The first matching param-list, or null if none match.

Throws:

RTNoSuchMethodException - If zero matches and crashIf_zero is YES, or more than one constructor/method matches and crashIf_moreThanOne is YES

See Also:

doesMatchAnyProt

indexOfStar

public int indexOfStar()

lastIndexOfStar

public int lastIndexOfStar()

doesMatch

public boolean doesMatch(SimpleParamNameSignature actual_cnstrMthd)

Does a constructor/method match?.

This function was a beast.

Parameters:

actual_cnstrMthd - May not be null.

toString

public String toString()

Overrides:

toString in class Object

Returns:

appendToString(new StringBuilder()).toString()

appendToString

public StringBuilder appendToString(StringBuilder to_appendTo)

The original shortcut as provided to the constructor, with a single space following each comma.

This appends getMethodName() + getWithParams().

See Also:

toString(), SimpleParamSigSearchTerm(String, Appendable, Appendable)