Package com.thoughtworks.paranamer
Class JavadocParanamer
java.lang.Object
com.thoughtworks.paranamer.JavadocParanamer
- All Implemented Interfaces:
Paranamer
Accesses Javadocs to extract parameter names. Supports:-
- Javadoc in zip file
- Javadoc in directory
- Javadoc at remote URL
- Author:
- Samuel Halliday
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
protected static interface
protected static class
protected static class
-
Field Summary
Fields inherited from interface com.thoughtworks.paranamer.Paranamer
EMPTY_NAMES
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected static String
getCanonicalName
(Class<?> klass) protected static String
getJavadocFilename
(Member member) 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)
-
Constructor Details
-
JavadocParanamer
- Parameters:
archiveOrDirectory
- either a zip archive or base directory of Javadocs.- Throws:
FileNotFoundException
- if the parameter orpackage-list
cannot be found.IOException
-
JavadocParanamer
- Parameters:
url
- base URL of the JavaDocs- Throws:
FileNotFoundException
- if the url does not have a/package-list
IOException
-
-
Method Details
-
lookupParameterNames
Description copied from interface:Paranamer
Lookup the parameter names of a given method.- Specified by:
lookupParameterNames
in interfaceParanamer
- Parameters:
accessible
- theMethod
orConstructor
for which the parameter names are looked up.- Returns:
- A list of the parameter names.
-
lookupParameterNames
Description copied from interface:Paranamer
Lookup the parameter names of a given method.- Specified by:
lookupParameterNames
in interfaceParanamer
- Parameters:
accessible
- theMethod
orConstructor
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.
-
getJavadocFilename
-
getCanonicalName
-
streamToString
- Throws:
IOException
-
urlToStream
- Throws:
IOException
-