Class JavadocParanamer

java.lang.Object

com.thoughtworks.paranamer.JavadocParanamer

All Implemented Interfaces:

Paranamer

public class JavadocParanamer
extends Object
implements Paranamer

Accesses Javadocs to extract parameter names. Supports:-

• Javadoc in zip file
• Javadoc in directory
• Javadoc at remote URL

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	JavadocParanamer.DirJavadocProvider
protected static interface	JavadocParanamer.JavadocProvider
protected static class	JavadocParanamer.UrlJavadocProvider
protected static class	JavadocParanamer.ZipJavadocProvider	///////// Provider Implementations ////////////

Field Summary

Fields

Modifier and Type	Field	Description
private final JavadocParanamer.JavadocProvider	provider

Fields inherited from interface Paranamer

EMPTY_NAMES

Constructor Summary

Constructors

Constructor	Description
JavadocParanamer(File archiveOrDirectory)
JavadocParanamer(URL url)

Method Summary

Modifier and Type	Method	Description
protected static String	getCanonicalName(Class<?> klass)
private String[]	getConstructorParameterNames(Constructor<?> cons, String raw)
protected static String	getJavadocFilename(Member member)	///////// CONVENIENCE METHODS ////////////
private String[]	getMethodParameterNames(Method method, String raw)
private String[]	getParameterNames(AccessibleObject a, String name, Class<?>[] types, String raw)
String[]	lookupParameterNames(AccessibleObject accessible)	Lookup the parameter names of a given method.
String[]	lookupParameterNames(AccessibleObject accessible, boolean throwExceptionIfMissing)	Lookup the parameter names of a given method.
protected static String	streamToString(InputStream input)
protected static InputStream	urlToStream(URL url)

Methods inherited from class Object

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

Field Details

provider

private final JavadocParanamer.JavadocProvider provider

Constructor Details

JavadocParanamer

public JavadocParanamer(File archiveOrDirectory)
                 throws IOException

Parameters:

archiveOrDirectory - either a zip archive or base directory of Javadocs.

Throws:

FileNotFoundException - if the parameter or package-list cannot be found.

IOException

JavadocParanamer

public JavadocParanamer(URL url)
                 throws IOException

Parameters:

url - base URL of the JavaDocs

Throws:

FileNotFoundException - if the url does not have a /package-list

IOException

Method Details

lookupParameterNames

public String[] lookupParameterNames(AccessibleObject accessible)

Description copied from interface: Paranamer

Lookup the parameter names of a given method.

Specified by:

lookupParameterNames in interface Paranamer

Parameters:

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

Returns:

A list of the parameter names.

lookupParameterNames

public String[] lookupParameterNames(AccessibleObject accessible,
 boolean throwExceptionIfMissing)

Description copied from interface: Paranamer

Lookup the parameter names of a given method.

Specified by:

lookupParameterNames in interface Paranamer

Parameters:

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

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

Returns:

A list of the parameter names.

getConstructorParameterNames

private String[] getConstructorParameterNames(Constructor<?> cons,
 String raw)

getMethodParameterNames

private String[] getMethodParameterNames(Method method,
 String raw)

getParameterNames

private String[] getParameterNames(AccessibleObject a,
 String name,
 Class<?>[] types,
 String raw)

getJavadocFilename

protected static String getJavadocFilename(Member member)

///////// CONVENIENCE METHODS ////////////

getCanonicalName

protected static String getCanonicalName(Class<?> klass)

streamToString

protected static String streamToString(InputStream input)
                                throws IOException

Throws:

IOException

urlToStream

protected static InputStream urlToStream(URL url)
                                  throws IOException

Throws:

IOException