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

Modifier and Type	Field and Description
private final JavadocParanamer.JavadocProvider	provider

Access	Constructor and Description
public	JavadocParanamer(File either a zip archive or base directory of Javadocs. archiveOrDirectory)
public	JavadocParanamer(URL base URL of the JavaDocs url)

Method Summary

Modifier and Type	Method and Description
protected static String	getCanonicalName(Class<?> klass)
private String[]	getConstructorParameterNames(Constructor<?> cons, String raw)
protected static String	getJavadocFilename(Member member)
private String[]	getMethodParameterNames(Method method, String raw)
private String[]	getParameterNames(AccessibleObject a, String name, Class<?>[] types, String raw)
public String[]	lookupParameterNames(AccessibleObject the `Method` or `Constructor` for which the parameter names are looked up. accessible) Implements com.thoughtworks.paranamer.Paranamer.lookupParameterNames. Lookup the parameter names of a given method.
public String[]	lookupParameterNames(AccessibleObject the `Method` or `Constructor` for which the parameter names are looked up. accessible, boolean whether to throw an exception if no Paranamer data found (versus return null). throwExceptionIfMissing) Implements com.thoughtworks.paranamer.Paranamer.lookupParameterNames. Lookup the parameter names of a given method.
protected static String	streamToString(InputStream input)
protected static InputStream	urlToStream(URL url)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

provider	back to summary
private final JavadocParanamer.JavadocProvider provider

Constructor Detail

JavadocParanamer	back to summary
public JavadocParanamer(File archiveOrDirectory) throws IOException Parameters archiveOrDirectory:File either a zip archive or base directory of Javadocs. Exceptions FileNotFoundException: if the parameter or `package-list` cannot be found.

JavadocParanamer	back to summary
public JavadocParanamer(URL url) throws IOException Parameters url:URL base URL of the JavaDocs Exceptions FileNotFoundException: if the url does not have a `/package-list`

Method Detail

getCanonicalName	back to summary
protected static String getCanonicalName(Class<?> klass)

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

getJavadocFilename	back to summary
protected static String getJavadocFilename(Member member)

getMethodParameterNames	back to summary
private String[] getMethodParameterNames(Method method, String raw)

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

lookupParameterNames back to summary

lookupParameterNames	back to summary
public String[] lookupParameterNames(AccessibleObject accessible) Implements com.thoughtworks.paranamer.Paranamer.lookupParameterNames. Doc from com.thoughtworks.paranamer.Paranamer.lookupParameterNames. Lookup the parameter names of a given method. Parameters accessible:AccessibleObject the `Method` or `Constructor` for which the parameter names are looked up. Returns:String[] A list of the parameter names.

public String[] lookupParameterNames(AccessibleObject accessible)

Implements com.thoughtworks.paranamer.Paranamer.lookupParameterNames.

Doc from com.thoughtworks.paranamer.Paranamer.lookupParameterNames.

Lookup the parameter names of a given method.

Parameters

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

Returns:String[]

A list of the parameter names.

lookupParameterNames back to summary

lookupParameterNames	back to summary
public String[] lookupParameterNames(AccessibleObject accessible, boolean throwExceptionIfMissing) Implements com.thoughtworks.paranamer.Paranamer.lookupParameterNames. Doc from com.thoughtworks.paranamer.Paranamer.lookupParameterNames. Lookup the parameter names of a given method. Parameters accessible: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.

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

Implements com.thoughtworks.paranamer.Paranamer.lookupParameterNames.

Doc from com.thoughtworks.paranamer.Paranamer.lookupParameterNames.

Lookup the parameter names of a given method.

Parameters

accessible: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.

streamToString	back to summary
protected static String streamToString(InputStream input) throws IOException

urlToStream	back to summary
protected static InputStream urlToStream(URL url) throws IOException

com.thoughtworks.paranamer back to summary

protected Class JavadocParanamer.DirJavadocProvider

Class Inheritance

extends Object
implements JavadocProvider

java.lang.Object
com.thoughtworks.paranamer.JavadocParanamer.DirJavadocProvider

All Implemented Interfaces

com.thoughtworks.paranamer.JavadocParanamer.JavadocProvider

Field Summary

Modifier and Type	Field and Description
private final File	dir

Constructor Summary

Access	Constructor and Description
public	DirJavadocProvider(File dir)

Method Summary

Modifier and Type	Method and Description
public InputStream	getRawJavadoc(String fqn) Implements com.thoughtworks.paranamer.JavadocParanamer.JavadocProvider.getRawJavadoc.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

dir	back to summary
private final File dir

Constructor Detail

DirJavadocProvider	back to summary
public DirJavadocProvider(File dir) throws IOException

Method Detail

getRawJavadoc	back to summary
public InputStream getRawJavadoc(String fqn) throws IOException Implements com.thoughtworks.paranamer.JavadocParanamer.JavadocProvider.getRawJavadoc.

com.thoughtworks.paranamer back to summary

protected Interface JavadocParanamer.JavadocProvider

Known Direct Implementers: com.thoughtworks.paranamer.JavadocParanamer.ZipJavadocProvider, com.thoughtworks.paranamer.JavadocParanamer.UrlJavadocProvider, com.thoughtworks.paranamer.JavadocParanamer.DirJavadocProvider

Method Summary

Modifier and Type	Method and Description
public InputStream	getRawJavadoc(String canonicalClassName)

Method Detail

getRawJavadoc	back to summary
public InputStream getRawJavadoc(String canonicalClassName) throws IOException

com.thoughtworks.paranamer back to summary

protected Class JavadocParanamer.UrlJavadocProvider

Class Inheritance

extends Object
implements JavadocProvider

java.lang.Object
com.thoughtworks.paranamer.JavadocParanamer.UrlJavadocProvider

All Implemented Interfaces

com.thoughtworks.paranamer.JavadocParanamer.JavadocProvider

Field Summary

Modifier and Type	Field and Description
private final URL	base

Constructor Summary

Access	Constructor and Description
public	UrlJavadocProvider(URL base)

Method Summary

Modifier and Type	Method and Description
public InputStream	getRawJavadoc(String fqn) Implements com.thoughtworks.paranamer.JavadocParanamer.JavadocProvider.getRawJavadoc.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

base	back to summary
private final URL base

Constructor Detail

UrlJavadocProvider	back to summary
public UrlJavadocProvider(URL base) throws IOException

Method Detail

getRawJavadoc	back to summary
public InputStream getRawJavadoc(String fqn) throws IOException Implements com.thoughtworks.paranamer.JavadocParanamer.JavadocProvider.getRawJavadoc.

com.thoughtworks.paranamer back to summary

protected Class JavadocParanamer.ZipJavadocProvider

Class Inheritance

extends Object
implements JavadocProvider

java.lang.Object
com.thoughtworks.paranamer.JavadocParanamer.ZipJavadocProvider

All Implemented Interfaces

com.thoughtworks.paranamer.JavadocParanamer.JavadocProvider

Field Summary

Modifier and Type	Field and Description
private final ZipFile	zip

Constructor Summary

Access	Constructor and Description
public	ZipJavadocProvider(File file)

Method Summary

Modifier and Type	Method and Description
private ZipEntry	find(String postfix)
public InputStream	getRawJavadoc(String fqn) Implements com.thoughtworks.paranamer.JavadocParanamer.JavadocProvider.getRawJavadoc.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

zip	back to summary
private final ZipFile zip

Constructor Detail

ZipJavadocProvider	back to summary
public ZipJavadocProvider(File file) throws IOException

Method Detail

find	back to summary
private ZipEntry find(String postfix) throws FileNotFoundException

getRawJavadoc	back to summary
public InputStream getRawJavadoc(String fqn) throws IOException Implements com.thoughtworks.paranamer.JavadocParanamer.JavadocProvider.getRawJavadoc.

public Class JavadocParanamer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class JavadocParanamer.DirJavadocProvider

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Interface JavadocParanamer.JavadocProvider

Method Summary

Method Detail

protected Class JavadocParanamer.UrlJavadocProvider

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class JavadocParanamer.ZipJavadocProvider

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail