Top Description Fields Methods
com.thoughtworks.paranamer

public Interface Paranamer

Known Direct Implementers
com.thoughtworks.paranamer.PositionalParanamer, com.thoughtworks.paranamer.AdaptiveParanamer, com.thoughtworks.paranamer.AnnotationParanamer, com.thoughtworks.paranamer.BytecodeReadingParanamer, com.thoughtworks.paranamer.CachingParanamer, com.thoughtworks.paranamer.DefaultParanamer, com.thoughtworks.paranamer.JavadocParanamer, com.thoughtworks.paranamer.NullParanamer
Imports
java.lang.reflect.AccessibleObject, .Constructor, .Method
Paranamer allows lookups of methods and constructors by parameter names.
Authors
Paul Hammant, Mauro Talevi

Field Summary

Modifier and TypeField and Description
public static final String[]
EMPTY_NAMES

Method Summary

Modifier and TypeMethod and Description
public String[]

Returns:

A list of the parameter names.
lookupParameterNames(AccessibleObject
the Method or Constructor for which the parameter names are looked up.
methodOrConstructor)

Lookup the parameter names of a given method.

public String[]

Returns:

A list of the parameter names.
lookupParameterNames(AccessibleObject
the Method or Constructor for which the parameter names are looked up.
methodOrConstructor, boolean
whether to throw an exception if no Paranamer data found (versus return null).
throwExceptionIfMissing)

Lookup the parameter names of a given method.

Field Detail

EMPTY_NAMESback to summary
public static final String[] EMPTY_NAMES

Method Detail

lookupParameterNamesback to summary
public String[] lookupParameterNames(AccessibleObject methodOrConstructor)

Lookup the parameter names of a given method.

Parameters
methodOrConstructor:AccessibleObject

the Method or Constructor for which the parameter names are looked up.

Returns:String[]

A list of the parameter names.

Exceptions
ParameterNamesNotFoundException:
if no parameter names were found.
NullPointerException:
if the parameter is null.
SecurityException:
if reflection is not permitted on the containing Class of the parameter
lookupParameterNamesback to summary
public String[] lookupParameterNames(AccessibleObject methodOrConstructor, boolean throwExceptionIfMissing)

Lookup the parameter names of a given method.

Parameters
methodOrConstructor:AccessibleObject

the Method or Constructor for which the parameter names are looked up.

throwExceptionIfMissing:boolean

whether to throw an exception if no Paranamer data found (versus return null).

Returns:String[]

A list of the parameter names.

Exceptions
ParameterNamesNotFoundException:
if no parameter names were found.
NullPointerException:
if the parameter is null.
SecurityException:
if reflection is not permitted on the containing Class of the parameter