public class ResourceDoclet
extends java.lang.Object
The ResourceDoc file contains the javadoc documentation of resource classes, so that this can be used for extending generated wadl with useful documentation.
Modifier and Type | Class and Description |
---|---|
(package private) static class |
ResourceDoclet.Loader |
Modifier and Type | Field and Description |
---|---|
private static java.util.logging.Logger |
LOG |
private static java.lang.String |
OPTION_CLASSPATH |
private static java.lang.String |
OPTION_DOC_PROCESSORS |
private static java.lang.String |
OPTION_OUTPUT |
private static java.util.regex.Pattern |
PATTERN_RESPONSE_REPRESENTATION |
Constructor and Description |
---|
ResourceDoclet() |
Modifier and Type | Method and Description |
---|---|
private static void |
addParamDocs(com.sun.javadoc.MethodDoc methodDoc,
MethodDocType methodDocType,
DocProcessor docProcessor) |
private static void |
addRequestRepresentationDoc(com.sun.javadoc.MethodDoc methodDoc,
MethodDocType methodDocType) |
private static void |
addResponseDoc(com.sun.javadoc.MethodDoc methodDoc,
MethodDocType methodDocType) |
private static <T,U> T[] |
copyOf(U[] original,
int newLength) |
private static java.lang.String[] |
getCDataElements(DocProcessor docProcessor) |
private static java.lang.Class<?>[] |
getJAXBContextClasses(ResourceDocType result,
DocProcessor docProcessor) |
private static java.lang.String |
getOptionArg(java.lang.String[][] options,
java.lang.String option) |
private static java.util.Map<java.lang.String,java.util.List<com.sun.javadoc.Tag>> |
getResponseRepresentationTags(com.sun.javadoc.MethodDoc methodDoc) |
private static java.lang.String |
getSerializedExample(com.sun.javadoc.Tag tag)
Searches an
@link tag within the inline tags of the specified tag
and serializes the referenced instance. |
private static java.lang.String |
getSerializedLinkFromTag(com.sun.javadoc.SeeTag linkTag) |
private static com.sun.javadoc.Tag |
getSingleTagOrNull(com.sun.javadoc.MethodDoc methodDoc,
java.lang.String tagName) |
private static org.apache.xml.serialize.XMLSerializer |
getXMLSerializer(java.io.OutputStream os,
java.lang.String[] cdataElements) |
private static boolean |
isEmpty(java.lang.String value) |
static int |
optionLength(java.lang.String option)
Return array length for given option: 1 + the number of arguments that
the option takes.
|
private static java.lang.String |
print(com.sun.javadoc.Tag tag) |
static boolean |
start(com.sun.javadoc.RootDoc root)
Start the doclet.
|
(package private) static java.lang.String |
toCSV(java.util.Collection<com.sun.javadoc.Tag> items) |
(package private) static java.lang.String |
toCSV(java.util.Collection<com.sun.javadoc.Tag> items,
java.lang.String separator,
java.lang.String delimiter) |
(package private) static java.lang.String |
toCSV(com.sun.javadoc.Tag[] items) |
private static boolean |
validOption(java.lang.String optionName,
java.lang.String reportOptionName,
java.lang.String[][] options,
com.sun.javadoc.DocErrorReporter reporter) |
static boolean |
validOptions(java.lang.String[][] options,
com.sun.javadoc.DocErrorReporter reporter)
Validate options.
|
private static final java.util.regex.Pattern PATTERN_RESPONSE_REPRESENTATION
private static final java.lang.String OPTION_OUTPUT
private static final java.lang.String OPTION_CLASSPATH
private static final java.lang.String OPTION_DOC_PROCESSORS
private static final java.util.logging.Logger LOG
public static boolean start(com.sun.javadoc.RootDoc root)
root
- the root JavaDoc document.private static java.lang.String[] getCDataElements(DocProcessor docProcessor)
private static <T,U> T[] copyOf(U[] original, int newLength)
private static java.lang.Class<?>[] getJAXBContextClasses(ResourceDocType result, DocProcessor docProcessor)
private static org.apache.xml.serialize.XMLSerializer getXMLSerializer(java.io.OutputStream os, java.lang.String[] cdataElements) throws java.lang.InstantiationException, java.lang.IllegalAccessException, java.lang.ClassNotFoundException
java.lang.InstantiationException
java.lang.IllegalAccessException
java.lang.ClassNotFoundException
private static void addResponseDoc(com.sun.javadoc.MethodDoc methodDoc, MethodDocType methodDocType)
private static boolean isEmpty(java.lang.String value)
private static void addRequestRepresentationDoc(com.sun.javadoc.MethodDoc methodDoc, MethodDocType methodDocType)
private static java.util.Map<java.lang.String,java.util.List<com.sun.javadoc.Tag>> getResponseRepresentationTags(com.sun.javadoc.MethodDoc methodDoc)
private static java.lang.String getSerializedExample(com.sun.javadoc.Tag tag)
@link
tag within the inline tags of the specified tag
and serializes the referenced instance.tag
- the tag containing the inline tags to be searched.String
representation of the Tag
or null if the parameter is null.private static com.sun.javadoc.Tag getSingleTagOrNull(com.sun.javadoc.MethodDoc methodDoc, java.lang.String tagName)
private static void addParamDocs(com.sun.javadoc.MethodDoc methodDoc, MethodDocType methodDocType, DocProcessor docProcessor)
private static java.lang.String getSerializedLinkFromTag(com.sun.javadoc.SeeTag linkTag)
private static java.lang.String print(com.sun.javadoc.Tag tag)
static java.lang.String toCSV(com.sun.javadoc.Tag[] items)
static java.lang.String toCSV(java.util.Collection<com.sun.javadoc.Tag> items)
static java.lang.String toCSV(java.util.Collection<com.sun.javadoc.Tag> items, java.lang.String separator, java.lang.String delimiter)
public static int optionLength(java.lang.String option)
option
- optionpublic static boolean validOptions(java.lang.String[][] options, com.sun.javadoc.DocErrorReporter reporter)
options
- options to be validatedreporter
- DocErrorReporter
for collecting eventual errorsprivate static boolean validOption(java.lang.String optionName, java.lang.String reportOptionName, java.lang.String[][] options, com.sun.javadoc.DocErrorReporter reporter)
private static java.lang.String getOptionArg(java.lang.String[][] options, java.lang.String option)