|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.kruis.padoclet.FilterDocletBase
de.kruis.padoclet.PublishedApiDoclet
public class PublishedApiDoclet
This class is a java 1.5 doclet, that is used as a filter between the javadoc
framework and another doclet, that produces some output.
The PublishedApiDoclet limits the packages, classes, fields, methods seen by
the second doclet based on exclude and include tags.
Technically this class is an application of the
FilterDocletBase
class.
Nested Class Summary | |
---|---|
static class |
PublishedApiDoclet.AnnotationDescHandler
Proxy methods for AnnotationDesc instances. |
static class |
PublishedApiDoclet.AnnotationTypeDocHandler
Proxy methods for ClassDoc instances. |
static class |
PublishedApiDoclet.ClassDocHandler
Proxy methods for ClassDoc instances. |
static class |
PublishedApiDoclet.DocHandler
Proxy methods and state common to all Doc instances. |
static class |
PublishedApiDoclet.MethodDocHandler
Proxy methods for the MethodDoc instance. |
static class |
PublishedApiDoclet.PackageDocHandler
Proxy methods for PackageDoc instances. |
static class |
PublishedApiDoclet.RootDocHandler
Proxy methods for the RootDoc instance. |
Nested classes/interfaces inherited from class de.kruis.padoclet.FilterDocletBase |
---|
FilterDocletBase.ComparableHandler, FilterDocletBase.HandlerBase, FilterDocletBase.Option |
Field Summary | |
---|---|
private boolean |
defaultIsExclude
the default mode. |
private int |
defaultPriority
the priority of the default setting. |
private boolean |
disableJavadocFilter
If true , retrieve all items from the javadoc core. |
private boolean |
dontFilterAnnotationElements
If true , do not filter annotation elements |
private boolean |
dontFilterEnumConstants
If true , do not filter enum constants |
private java.util.regex.Pattern |
excludeChildsFilter
the excludeChilds filter regular expression. |
private java.lang.String |
excludeChildsTag
the name of the excludeChilds tag. |
private java.util.regex.Pattern |
excludeFilter
the exclude filter regular expression. |
private java.lang.String |
excludeTag
the name of the exclude tag. |
private java.util.regex.Pattern |
forceIncludeFilter
the forceInclude filter regular expression. |
private java.lang.String |
forceIncludeTag
the name of the forceInclude tag. |
private boolean |
ignoreJavadocIsIncluded
If true , don't call Doc.isIncluded() . |
private java.util.regex.Pattern |
includeFilter
the include filter regular expression. |
private java.lang.String |
includeTag
the name of the include tag. |
Fields inherited from class de.kruis.padoclet.FilterDocletBase |
---|
PAD_DELEGATE_DOCLET_SYSTEM_PROPERTY |
Fields inherited from interface de.kruis.padoclet.util.HalfDynamicProxy.MessageInterface |
---|
PRIORITY_DEBUG, PRIORITY_ERROR, PRIORITY_WARN |
Constructor Summary | |
---|---|
private |
PublishedApiDoclet()
Create a new instance |
Method Summary | |
---|---|
int |
getDefaultPriority()
|
java.lang.String |
getExcludeChildsFilter()
|
java.util.regex.Pattern |
getExcludeChildsFilterPat()
|
java.lang.String |
getExcludeChildsTag()
|
java.lang.String |
getExcludeFilter()
|
java.util.regex.Pattern |
getExcludeFilterPat()
|
java.lang.String |
getExcludeTag()
|
java.lang.String |
getForceIncludeFilter()
|
java.util.regex.Pattern |
getForceIncludeFilterPat()
|
java.lang.String |
getForceIncludeTag()
|
java.lang.String |
getIncludeFilter()
|
java.util.regex.Pattern |
getIncludeFilterPat()
|
java.lang.String |
getIncludeTag()
|
boolean |
isDefaultIsExclude()
|
boolean |
isDisableJavadocFilter()
|
boolean |
isDontFilterAnnotationElements()
|
boolean |
isDontFilterEnumConstants()
|
boolean |
isIgnoreJavadocIsIncluded()
|
static com.sun.javadoc.LanguageVersion |
languageVersion()
Implements the doclet languageVersion method. |
static void |
main(java.lang.String[] args)
A main method. |
static int |
optionLength(java.lang.String option)
The doclet optionLength method. |
protected void |
preDelegateStartHook(com.sun.javadoc.RootDoc filteredRootDoc)
Hook method called prior to the start-method of the delegate doclet. |
void |
setDefaultIsExclude(boolean defaultIsExclude)
|
void |
setDefaultPriority(int defaultPriority)
|
void |
setDisableJavadocFilter(boolean disableJavadocFilter)
|
void |
setDontFilterAnnotationElements(boolean dontFilterAnnotationElements)
|
void |
setDontFilterEnumConstants(boolean dontFilterEnumConstants)
|
void |
setExcludeChildsFilter(java.lang.String excludeChildsFilter)
|
void |
setExcludeChildsTag(java.lang.String excludeChildsTag)
|
void |
setExcludeFilter(java.lang.String excludeFilter)
|
void |
setExcludeTag(java.lang.String excludeTag)
|
void |
setForceIncludeFilter(java.lang.String forceIncludeFilter)
|
void |
setForceIncludeTag(java.lang.String forceIncludeTag)
|
void |
setIgnoreJavadocIsIncluded(boolean ignoreJavadocIsIncluded)
|
void |
setIncludeFilter(java.lang.String includeFilter)
|
void |
setIncludeTag(java.lang.String includeTag)
|
static boolean |
start(com.sun.javadoc.RootDoc root)
The doclet start method. |
static boolean |
validOptions(java.lang.String[][] options,
com.sun.javadoc.DocErrorReporter reporter)
Implements the doclet validOptions method |
Methods inherited from class de.kruis.padoclet.FilterDocletBase |
---|
emitMessage, filterOptions, getErrorReporter, languageVersionHelper, optionLengthHelper, setErrorReporter, startHelper, validOptionsHelper |
Field Detail |
---|
private java.lang.String excludeTag
pad.exclude
.
private java.util.regex.Pattern excludeFilter
private java.lang.String includeTag
pad.include
.
private java.util.regex.Pattern includeFilter
private java.lang.String forceIncludeTag
pad.forceInclude
.
private java.util.regex.Pattern forceIncludeFilter
private java.lang.String excludeChildsTag
pad.excludeChilds
.
private java.util.regex.Pattern excludeChildsFilter
private boolean defaultIsExclude
true
, everything is excluded by default.
Default is false
/ include.
private int defaultPriority
private boolean disableJavadocFilter
true
, retrieve all items from the javadoc core. Otherwise
retrieve only the included subset.
private boolean ignoreJavadocIsIncluded
true
, don't call Doc.isIncluded()
.
private boolean dontFilterEnumConstants
true
, do not filter enum constants
private boolean dontFilterAnnotationElements
true
, do not filter annotation elements
Constructor Detail |
---|
private PublishedApiDoclet()
Method Detail |
---|
public final boolean isDefaultIsExclude()
public final void setDefaultIsExclude(boolean defaultIsExclude)
defaultIsExclude
- The defaultIsExclude to set.public final int getDefaultPriority()
public final void setDefaultPriority(int defaultPriority)
defaultPriority
- The defaultPriority to set.public final boolean isDisableJavadocFilter()
public final void setDisableJavadocFilter(boolean disableJavadocFilter)
disableJavadocFilter
- The disableJavadocFilter to set.public final java.lang.String getExcludeChildsFilter()
public final java.util.regex.Pattern getExcludeChildsFilterPat()
public final void setExcludeChildsFilter(java.lang.String excludeChildsFilter)
excludeChildsFilter
- The excludeChildsFilter to set.public final java.lang.String getExcludeChildsTag()
public final void setExcludeChildsTag(java.lang.String excludeChildsTag)
excludeChildsTag
- The excludeChildsTag to set.public final java.lang.String getExcludeFilter()
public final java.util.regex.Pattern getExcludeFilterPat()
public final void setExcludeFilter(java.lang.String excludeFilter)
excludeFilter
- The excludeFilter to set.public final java.lang.String getForceIncludeFilter()
public final java.util.regex.Pattern getForceIncludeFilterPat()
public final void setForceIncludeFilter(java.lang.String forceIncludeFilter)
forceIncludeFilter
- The forceIncludeFilter to set.public final java.lang.String getForceIncludeTag()
public final void setForceIncludeTag(java.lang.String forceIncludeTag)
forceIncludeTag
- The forceIncludeTag to set.public final boolean isIgnoreJavadocIsIncluded()
public final void setIgnoreJavadocIsIncluded(boolean ignoreJavadocIsIncluded)
ignoreJavadocIsIncluded
- The ignoreJavadocIsIncluded to set.public final java.lang.String getIncludeFilter()
public final java.util.regex.Pattern getIncludeFilterPat()
public final void setIncludeFilter(java.lang.String includeFilter)
includeFilter
- The includeFilter to set.public final java.lang.String getExcludeTag()
public final void setExcludeTag(java.lang.String excludeTag)
excludeTag
- The excludeTag to set.public final java.lang.String getIncludeTag()
public final void setIncludeTag(java.lang.String includeTag)
includeTag
- The includeTag to set.public final boolean isDontFilterAnnotationElements()
public final void setDontFilterAnnotationElements(boolean dontFilterAnnotationElements)
dontFilterAnnotationElements
- the dontFilterAnnotationElements to setpublic final boolean isDontFilterEnumConstants()
public final void setDontFilterEnumConstants(boolean dontFilterEnumConstants)
dontFilterEnumConstants
- the dontFilterEnumConstants to setpublic static com.sun.javadoc.LanguageVersion languageVersion()
LanguageVersion.JAVA_1_5
.
public static boolean validOptions(java.lang.String[][] options, com.sun.javadoc.DocErrorReporter reporter) throws java.io.IOException
options
- the optionsreporter
- used to emit messages
true
, is everything is ok, false
otherwise.
java.io.IOException
Doclet.validOptions(java.lang.String[][], com.sun.javadoc.DocErrorReporter)
public static int optionLength(java.lang.String option)
option
- the name of the option
Doclet.optionLength(java.lang.String)
public static boolean start(com.sun.javadoc.RootDoc root) throws java.io.IOException
root
- the RootDoc object
true
, if everything is ok, otherwise false
.
java.io.IOException
Doclet.start(com.sun.javadoc.RootDoc)
protected void preDelegateStartHook(com.sun.javadoc.RootDoc filteredRootDoc)
FilterDocletBase
preDelegateStartHook
in class FilterDocletBase
filteredRootDoc
- the filtered RootDoc.public static void main(java.lang.String[] args)
args
- the command line argumentsMain.execute(java.lang.String, java.lang.String, java.lang.String[])
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |