com.github.aliteralmind.codelet.simplesig

Class AllSimpleParamSignatures

java.lang.Object

com.github.aliteralmind.codelet.simplesig.AllSimpleParamSignatures

public class AllSimpleParamSignatures
extends Object

All constructors and methods in a class.

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
AllSimpleParamSignatures(Class<?> containing_cls, Declared declared) Create a new instance from a class.

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	appendFullToString(StringBuilder to_appendTo) A full listing of all constructors and functions.
StringBuilder	appendToString(StringBuilder to_appendTo) A summary of all constructors and functions.
static StringBuilder	appendToStringForAllListsInArray(StringBuilder to_appendTo, String prefix, SimpleParamNameSignature[] param_lists, String between) For displaying all parameter-lists in an array.
static StringBuilder	appendToStringForAllListsInList(StringBuilder to_appendTo, String prefix, List<? extends SimpleParamNameSignature> param_listList, String between) For displaying all parameter-lists in a list.
String	fullToString()
List<ConstructorSimpleParamSig>	getConstructorList() All constructors.
Class<?>	getContainingClass() The class containing the constructors and methods.
List<MethodSimpleParamSig>	getMethodListForNameCrashIfNone(String name) Get the methods with a name, or crash if no methods have that name.
Map<String,List<MethodSimpleParamSig>>	getMethodMap() All methods.
static List<ConstructorSimpleParamSig>	newConstructorList(Class<?> containing_cls, Declared declared, Sorted sort) Create a new list of all constructors in a class.
static Map<String,List<MethodSimpleParamSig>>	newMethodMap(Class<?> containing_cls, Declared declared, SortListValues sort_lists, ImmutableValues immutable_lists) Create a new map of all methods in a class.
String	toString()
static String	toStringForAllListsInArray(String prefix, SimpleParamNameSignature[] param_lists, String between) For displaying all parameter-lists in an array.
static String	toStringForAllListsInList(String prefix, List<? extends SimpleParamNameSignature> param_listList, String between) For displaying all parameter-lists in a list.

Methods inherited from class java.lang.Object

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

Constructor Detail

AllSimpleParamSignatures

public AllSimpleParamSignatures(Class<?> containing_cls,
                        Declared declared)

Create a new instance from a class.

Sets

1. getConstructorList() to an immutable version of
   AllSimpleParamSignatures.newConstructorList(containing_cls, declared, Sorted.YES)
2. getMethodMap() to an immutable version of
   AllSimpleParamSignatures.newMethodMap(containing_cls, declared, SortListValues.ORIGINAL, ImmutableValues.YES)

Parameters:

containing_cls - The class containing the methods. May not be null and should be the class whose methods are in map. Get with getContainingClass(). Get with getMethodMap().

Method Detail

getConstructorList

public List<ConstructorSimpleParamSig> getConstructorList()

All constructors.

Returns:

A non-null, immutable list of all constructors in the class.

See Also:

getMethodMap(), AllSimpleParamSignatures(Class, Declared)

getMethodMap

public Map<String,List<MethodSimpleParamSig>> getMethodMap()

All methods.

Returns:

A non-null, immutable map of all methods in the class.

See Also:

getConstructorList(), AllSimpleParamSignatures(Class, Declared), getMethodListForNameCrashIfNone(String)

getMethodListForNameCrashIfNone

public List<MethodSimpleParamSig> getMethodListForNameCrashIfNone(String name)

Get the methods with a name, or crash if no methods have that name.

Returns:

getMethodMap().get(name)

Throws:

RTNoSuchMethodException - If no methods have the name name.

getContainingClass

public Class<?> getContainingClass()

The class containing the constructors and methods.

See Also:

AllSimpleParamSignatures(Class, Declared)

toString

public String toString()

Overrides:

toString in class Object

Returns:

appendToString(new StringBuilder()).toString()

appendToString

public StringBuilder appendToString(StringBuilder to_appendTo)

A summary of all constructors and functions.

Parameters:

to_appendTo - May not be null.

See Also:

toString()

fullToString

public String fullToString()

Returns:

appendFullToString(new StringBuilder()).toString()

appendFullToString

public StringBuilder appendFullToString(StringBuilder to_appendTo)

A full listing of all constructors and functions.

Parameters:

to_appendTo - May not be null.

See Also:

fullToString()

toStringForAllListsInList

public static final String toStringForAllListsInList(String prefix,
                               List<? extends SimpleParamNameSignature> param_listList,
                               String between)

For displaying all parameter-lists in a list.

Returns:

appendToStringForAllListsInArray((new StringBuilder()), prefix, param_listList, between).toString()

appendToStringForAllListsInList

public static final StringBuilder appendToStringForAllListsInList(StringBuilder to_appendTo,
                                            String prefix,
                                            List<? extends SimpleParamNameSignature> param_listList,
                                            String between)

For displaying all parameter-lists in a list.

Returns:

appendToStringForAllListsInArray(new StringBuilder(), prefix, methods, between).toString()

toStringForAllListsInArray

public static final String toStringForAllListsInArray(String prefix,
                                SimpleParamNameSignature[] param_lists,
                                String between)

For displaying all parameter-lists in an array.

Returns:

appendToStringForAllListsInArray(new StringBuilder(), prefix, methods, between).toString()

appendToStringForAllListsInArray

public static final StringBuilder appendToStringForAllListsInArray(StringBuilder to_appendTo,
                                             String prefix,
                                             SimpleParamNameSignature[] param_lists,
                                             String between)

For displaying all parameter-lists in an array.

Parameters:

to_appendTo - May not be null.

prefix - What to print before each method. Setting this to null is the same as setting it to the empty-string ("").

param_lists - May not be null, and no element may be null.

between - What to print between each method. Should not be null or empty.

newConstructorList

public static final List<ConstructorSimpleParamSig> newConstructorList(Class<?> containing_cls,
                                                 Declared declared,
                                                 Sorted sort)

Create a new list of all constructors in a class.

Parameters:

containing_cls - May not be null.

declared - If Declared.YES, then declared methods are retrieved. If NO, non-declared.

sort - If ORIGINAL or DUPLICATE, then the returned list is sorted.

newMethodMap

public static final Map<String,List<MethodSimpleParamSig>> newMethodMap(Class<?> containing_cls,
                                                  Declared declared,
                                                  SortListValues sort_lists,
                                                  ImmutableValues immutable_lists)

Create a new map of all methods in a class.

Parameters:

containing_cls - May not be null.

declared - If Declared.YES, then declared methods are retrieved. If NO, non-declared.

Returns:

A non-null map containing all methods. This ends by returning
MapUtil.<MethodSimpleParamSig,String>getWithModifiedListValues([the-map], sort_lists, immutable_lists)