com.github.aliteralmind.codelet.simplesig

Class SimpleParamNameSignature

java.lang.Object

com.github.aliteralmind.codelet.simplesig.SimpleParamNameSignature

All Implemented Interfaces:

Comparable<SimpleParamNameSignature>

Direct Known Subclasses:

ConstructorSimpleParamSig, MethodSimpleParamSig

public abstract class SimpleParamNameSignature
extends Object
implements Comparable<SimpleParamNameSignature>

A method or constructor signature, using only simple parameter-type names--this can be matched by a SimpleParamSigSearchTerm. This class is unrelated to SimpleMethodSignature.

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:

SimpleParamSigSearchTerm

Constructor Summary

Constructors

Constructor and Description
SimpleParamNameSignature(Member cnstr_method, Class<?>[] param_types) Create a new instance from a constructor or method, and its parameter class types.
SimpleParamNameSignature(Member cnstr_method, List<String> type_list) Create a new instance from a method or constructor, and an array of its parameter simple names.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(SimpleParamNameSignature to_compareTo)
Member	getMember() The method or constructor having these parameters.
abstract String	getMethodName() If a method: its name, if a constructor: the empty string ("").
String	getNoParens() Comma-delimited string of all parameter-type simple names, excluding the surrounding parentheses.
List<String>	getParamNameList() List of all parameter-type simple names.
static List<String>	getSimpleNameListFromClasses(Class<?>[] types) Create a list of all simple names from a class array.
String	getWithParens() Comma-delimited string of all parameter-type simple names, listed in the same order as declared, including the surrounding parentheses.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleParamNameSignature

public SimpleParamNameSignature(Member cnstr_method,
                        Class<?>[] param_types)

Create a new instance from a constructor or method, and its parameter class types.

Equal to
this(false, cnstr_method,
SimpleParamNameSignature.getSimpleNameListFromClasses(param_types))

SimpleParamNameSignature

public SimpleParamNameSignature(Member cnstr_method,
                        List<String> type_list)

Create a new instance from a method or constructor, and an array of its parameter simple names.

This sets

1. getParamNameList() to an immutable string-list of all parameter type names.
2. getWithParens() to a comma-delimited string of the each type's simple names, in the same order as in types, surrounded by parentheses.
3. getNoParens() to the same comma-delimited list, with no paretheses.

See Also:

Class.getSimpleName()

Method Detail

getMember

public Member getMember()

The method or constructor having these parameters.

Returns:

A non-null method or constructor object.

getParamNameList

public List<String> getParamNameList()

List of all parameter-type simple names.

Returns:

An immutable list of all parameter-types, in the same order as they exist in the consructor or function. If no parameters, this is an empty list.

See Also:

getWithParens(), SimpleParamNameSignature(Member, List), Class.getSimpleName()

getNoParens

public String getNoParens()

Comma-delimited string of all parameter-type simple names, excluding the surrounding parentheses.

Returns:

A non-null, comma-delimited string of all simple type names, in the same order as declared, with a single space between each comma.

See Also:

getWithParens()

getWithParens

public String getWithParens()

Comma-delimited string of all parameter-type simple names, listed in the same order as declared, including the surrounding parentheses.

Returns:

A non-null, comma-delimited string of all simple type names, in the same order as declared, with a single space between each comma.

See Also:

getParamNameList(), getNoParens(), toString()

getMethodName

public abstract String getMethodName()

If a method: its name, if a constructor: the empty string ("").

toString

public String toString()

Overrides:

toString in class Object

Returns:

getMethodName() + getWithParens()

compareTo

public int compareTo(SimpleParamNameSignature to_compareTo)

Specified by:

compareTo in interface Comparable<SimpleParamNameSignature>

Returns:

getWithParens().compareTo(to_compareTo.getWithParens()) (This does not need to be overriden to include the constructor/function name. This is only for sorting parameter-lists within each constructor/method.)

getSimpleNameListFromClasses

public static final List<String> getSimpleNameListFromClasses(Class<?>[] types)

Create a list of all simple names from a class array.

Parameters:

types - May not be null.

Returns:

A non-null list having the same length as types.

See Also:

SimpleParamNameSignature(Member, Class[])