com.github.aliteralmind.codelet.simplesig

Class MethodSigSearchTerm

java.lang.Object

com.github.aliteralmind.codelet.simplesig.SimpleParamSigSearchTerm

com.github.aliteralmind.codelet.simplesig.MethodSigSearchTerm

public class MethodSigSearchTerm
extends SimpleParamSigSearchTerm

Search term for methods.

MethodSigSearchTerm: Example

Source code

   import  com.github.aliteralmind.codelet.simplesig.AllSimpleParamSignatures;
   import  com.github.aliteralmind.codelet.simplesig.MethodSigSearchTerm;
   import  com.github.aliteralmind.codelet.simplesig.MethodSimpleParamSig;
   import  com.github.aliteralmind.codelet.simplesig.CrashIfMoreThanOne;
   import  com.github.aliteralmind.codelet.simplesig.CrashIfZero;
   import  com.github.xbn.lang.reflect.Declared;
   import  java.util.List;

public class MethodSigSearchTermXmpl  {
   public static final String LINE_SEP = System.getProperty("line.separator", "\r\n");
   public static final void main(String[] ignored)  {

      AllSimpleParamSignatures allInClass = new AllSimpleParamSignatures(
         MethodSigSearchTermXmpl.class, Declared.NO);

      test(allInClass, "nonExisting()");
      test(allInClass, "doSomething()");
      test(allInClass, "doSomething(*)");
      test(allInClass, "doSomething(*,byte,*)");
   }
   private static void test(AllSimpleParamSignatures all_inClass, String param_searchTerm)  {

      MethodSigSearchTerm searchTerm = new MethodSigSearchTerm(param_searchTerm, null, null);

      System.out.println("Searching for: \"" + param_searchTerm + "\"");

      if(!searchTerm.doesMatchAny(all_inClass))  {
         System.out.println("   Not found.");
         System.out.println();
         return;
      }

      MethodSimpleParamSig first = searchTerm.getFirstMatch(
         all_inClass, CrashIfZero.NO, CrashIfMoreThanOne.NO);

      List<MethodSimpleParamSig> allMatches = searchTerm.getAllMatches(
         all_inClass, CrashIfZero.NO);

      System.out.println("   - First match: " + first);
      System.out.println("   - All matches:" + LINE_SEP +
         AllSimpleParamSignatures.toStringForAllListsInList("      - ", allMatches, LINE_SEP));

      System.out.println();
   }
   public String doSomething(String s, boolean b, int i, Object o)  {
      return  null;
   }
   public String doSomething(String s, boolean b, int[] i, byte y, Object o)  {
      return  null;
   }
}

Output:

Searching for: "nonExisting()"
   Not found.

Searching for: "doSomething()"
   Not found.

Searching for: "doSomething(*)"
   - First match: doSomething(String, boolean, int, Object)
   - All matches:
      - doSomething(String, boolean, int, Object)
      - doSomething(String, boolean, int[], byte, Object)

Searching for: "doSomething(*,byte,*)"
   - First match: doSomething(String, boolean, int[], byte, Object)
   - All matches:
      - doSomething(String, boolean, int[], byte, Object)

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

Constructor Summary

Constructors

Constructor and Description
MethodSigSearchTerm(String search_termSig, Appendable debugBasics_ifNonNull, Appendable dbgDoesMatch_ifNonNull) Create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	doesMatchAny(AllSimpleParamSignatures all_methods) Does any match?.
boolean	doesMatchOnlyOne(AllSimpleParamSignatures all_methods) Does exactly one match?.
List<MethodSimpleParamSig>	getAllMatches(AllSimpleParamSignatures all_methods, CrashIfZero crashIf_zero) Get a new list of all matches.
MethodSimpleParamSig	getFirstMatch(AllSimpleParamSignatures all_methods, CrashIfZero crashIf_zero, CrashIfMoreThanOne crashIf_moreThanOne) Get the first match.
static Method	getMethodFromAllSigsAndSearchTerm(AllSimpleParamSignatures all_sigs, String sig_searchTerm, Appendable debugBasics_ifNonNull, Appendable dbgDoesMatch_ifNonNull) Get the single matching method from an all-signature object.
MethodSimpleParamSig	getOnlyMatch(AllSimpleParamSignatures all_methods) Get the first and only match.

Methods inherited from class com.github.aliteralmind.codelet.simplesig.SimpleParamSigSearchTerm

appendToString, doesMatch, doesMatchAnyProt, doesMatchOnlyOneProt, getAllMatchesProt, getDebugAptrBasics, getDebugAptrDoesMatch, getFirstMatchProt, getMethodName, getNoParams, getOnlyMatchProt, getTermList, getWithParams, hasAStar, indexOfStar, lastIndexOfStar, setDebug, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodSigSearchTerm

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

Create a new instance.

Examples

doSomething()

A function named "doSomething" with exactly zero parameters.

doSomething(*)

One or more parameters of any type.

doSomething(String, *)

A java.lang.String, followed by one or more parameters of any type.

doSomething(String, *, int...)

A java.lang.String and int-ellipsis, with one or more parameters of any type between.

This first calls
super(search_termSig)

Parameters:

search_termSig - The function name may not be empty.

Method Detail

doesMatchAny

public boolean doesMatchAny(AllSimpleParamSignatures all_methods)

Does any match?.

Parameters:

all_methods - May not be null.

Returns:

If
all_methods.getMethodMap().get(getMethodName())
returns a non-null list, this returns doesMatchAnyProt([the-list])*

See Also:

doesMatchOnlyOne

doesMatchOnlyOne

public boolean doesMatchOnlyOne(AllSimpleParamSignatures all_methods)

Does exactly one match?.

Parameters:

all_methods - May not be null.

Returns:

If
all_methods.getMethodMap().get(getMethodName())
returns a non-null list, this returns doesMatchOnlyOneProt([the-list])*

See Also:

doesMatchAny

getAllMatches

public List<MethodSimpleParamSig> getAllMatches(AllSimpleParamSignatures all_methods,
                                       CrashIfZero crashIf_zero)

Get a new list of all matches.

Parameters:

all_methods - 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:

all matches, or null if no matches

Throws:

RTNoSuchMethodException - If zero matches and crashIf_zero is YES.

getOnlyMatch

public MethodSimpleParamSig getOnlyMatch(AllSimpleParamSignatures all_methods)

Get the first and only match.

Returns:

getFirstMatch(all_methods, CrashIfZero.YES, CrashIfMoreThanOne.YES)

See Also:

doesMatchOnlyOne, getFirstMatch, getOnlyMatch

getFirstMatch

public MethodSimpleParamSig getFirstMatch(AllSimpleParamSignatures all_methods,
                                 CrashIfZero crashIf_zero,
                                 CrashIfMoreThanOne crashIf_moreThanOne)

Get the first match.

Parameters:

all_methods - 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:

The first match, or null if no matches.

Throws:

RTNoSuchMethodException - If zero matches and crashIf_zero is YES.

See Also:

getOnlyMatch

getMethodFromAllSigsAndSearchTerm

public static final Method getMethodFromAllSigsAndSearchTerm(AllSimpleParamSignatures all_sigs,
                                       String sig_searchTerm,
                                       Appendable debugBasics_ifNonNull,
                                       Appendable dbgDoesMatch_ifNonNull)

Get the single matching method from an all-signature object.

Returns:

(new MethodSigSearchTerm(sig_searchTerm, debugBasics_ifNonNull, dbgDoesMatch_ifNonNull)).
getOnlyMatch(all_sigs).getMethod()