Package org.opengis.tools.taglet
Class DepartureElement
java.lang.Object
org.opengis.tools.taglet.DepartureElement
- All Implemented Interfaces:
Comparable<DepartureElement>
An element in the
Departure.departures
list.
Note: compareTo(org.opengis.tools.taglet.DepartureElement)
is inconsistent with Object.equals(java.lang.Object)
, but the
Departure
taglet doesn't use the equals
method anyway.
- Since:
- 2.3
- Version:
- 3.0.2
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final boolean
true
if this element is for a field or method.private final boolean
true
if this element is for a package.private final String
The class or method name that contains the departure.private final String
Path to HTML javadoc.private final String
The simple name (without path or extension) of the type that contains the departure.(package private) final String
The departure text.private final String
"Package", "Interface", "Class", "Method", "Field" or "Enum".(package private) final Name
Qualified name of the type, package or module that contains the departure. -
Constructor Summary
ConstructorsConstructorDescriptionDepartureElement
(Element parent, com.sun.source.doctree.DocTree tag, String text) Stores a description for the given departure tag. -
Method Summary
Modifier and TypeMethodDescriptionint
compareTo
(DepartureElement other) For sorting in the order to be published on the HTML page.(package private) final void
writeClassName
(Writer out) Writes the a class name to the given writer.(package private) final void
writeFieldName
(Writer out) Writes the a field name to the given writer.
-
Field Details
-
typeName
Qualified name of the type, package or module that contains the departure. Used for inferring the source file path relative to the javadoc root directory. -
shortTypeName
The simple name (without path or extension) of the type that contains the departure. -
pathToHTML
Path to HTML javadoc. -
type
"Package", "Interface", "Class", "Method", "Field" or "Enum". -
name
The class or method name that contains the departure. May be the same thanshortTypeName
. -
text
The departure text. -
isMember
final boolean isMembertrue
if this element is for a field or method.false
if this element is for an interface, class or package. -
isPackage
private final boolean isPackagetrue
if this element is for a package.
-
-
Constructor Details
-
DepartureElement
Stores a description for the given departure tag.
-
-
Method Details
-
compareTo
For sorting in the order to be published on the HTML page.- Specified by:
compareTo
in interfaceComparable<DepartureElement>
-
writeClassName
Writes the a class name to the given writer.- Throws:
IOException
-
writeFieldName
Writes the a field name to the given writer.- Throws:
IOException
-