public static class PublishedApiDoclet.DocHandler extends FilterDocletBase.ComparableHandler
Doc
instances.HalfDynamicProxy.MessageInterface
Modifier and Type | Field and Description |
---|---|
private int |
childInclusionPriority
Cached inclusion priority for childs of this node.
|
private static java.util.regex.Pattern |
digits
A constant used by
tagPriority(Doc, String, Pattern) . |
private int |
inclusionPriority
Cached inclusion priority for this node.
|
private boolean |
inclusionPriorityValid
Indicates, if
inclusionPriority and childInclusionPriority is
valid. |
private boolean |
isCheckStarted
Flag, that is used to avoid infinite recursion.
|
private boolean |
isIncluded
The value of this field is only valid, if
isIncludedValid
is true . |
private boolean |
isIncludedValid
if
true , the inclusion state is known and
isIncluded is valid |
target
Constructor and Description |
---|
PublishedApiDoclet.DocHandler()
Create a new instance.
|
Modifier and Type | Method and Description |
---|---|
private int |
calcInclusionPriority(boolean iscallFromChild)
Check, if this item shall be included.
|
protected void |
debug(java.lang.String message)
print a debug message.
|
protected com.sun.javadoc.Doc[] |
filterDocArray(com.sun.javadoc.Doc[] array,
java.lang.Class<? extends com.sun.javadoc.Doc[]> expect,
boolean doFilter)
Filter the content of a com.sun.javadoc.Doc-array, in order to remove entries not to be documented.
|
protected boolean |
isFilter(boolean filter)
Determinate, if a com.sun.javadoc.Doc array shall be filtered.
|
boolean |
isIncluded()
Get the value of the boolean included property of the Doc
object, that is represented by this dynamic proxy instance.
|
private static int |
tagPriority(com.sun.javadoc.Doc doc,
java.lang.String tag,
java.util.regex.Pattern filter)
Get the priority from a tag.
|
compareTo
dynamicProxyInstance, equals, getHDPProxy, getHDPProxy, getHDPStateUserObject, getInvocationTarget, getProxyClassTable, hashCode, invoke, setProxyClassTable, setupInvocationHandler, stateFactory, toString, unwrap
private boolean isIncluded
isIncludedValid
is true
.
Then this field determinates, if the Doc instance is included.private boolean isIncludedValid
true
, the inclusion state is known and
isIncluded
is validprivate boolean isCheckStarted
private int inclusionPriority
inclusionPriorityValid
is true
.private int childInclusionPriority
inclusionPriorityValid
is true
.private boolean inclusionPriorityValid
inclusionPriority
and childInclusionPriority
is
valid.private static final java.util.regex.Pattern digits
tagPriority(Doc, String, Pattern)
.public PublishedApiDoclet.DocHandler()
public boolean isIncluded()
true
, if this node (package, class, method, field)
shall be included in the documentation.Doc.isIncluded()
private static int tagPriority(com.sun.javadoc.Doc doc, java.lang.String tag, java.util.regex.Pattern filter)
doc
- the document node (package, class, method, field, ...)tag
- the name of the tagfilter
- a filter pattern. Only tags, that match this pattern are
looked at.private int calcInclusionPriority(boolean iscallFromChild)
iscallFromChild
- if true
return the inclusion priority
for a child item, otherwise return the inclusion priority for this item.protected com.sun.javadoc.Doc[] filterDocArray(com.sun.javadoc.Doc[] array, java.lang.Class<? extends com.sun.javadoc.Doc[]> expect, boolean doFilter)
array
- the array of doc items.expect
- the class of the concrete array type, i.e. com.sun.javadoc.PackageDoc[].class
,
if array contains PackageDoc items.doFilter
- if false
, simply return a HD-proxy for array.protected boolean isFilter(boolean filter)
filter
- if false
, do not filter.false
, if either the filter parameter is false or if
the filter is globally disabled.protected void debug(java.lang.String message)
FilterDocletBase.HandlerBase
debug
in class FilterDocletBase.HandlerBase