Class DepartureElement

java.lang.Object
org.opengis.tools.taglet.DepartureElement
All Implemented Interfaces:
Comparable<DepartureElement>
final class DepartureElement extends Object implements Comparable<DepartureElement>
An element in the Departure.departures list.

Note: compareTo(DepartureElement) is inconsistent with Object.equals(Object), but the Departure taglet doesn't use the equals method anyway.

Since:
2.3
Version:
3.0.2

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    (package private) final boolean
    isMember
    true if this element is for a field or method.
    private final boolean
    isPackage
    true if this element is for a package.
    private final String
    name
    The class or method name that contains the departure.
    private final String
    pathToHTML
    Path to HTML javadoc.
    private final String
    shortTypeName
    The simple name (without path or extension) of the type that contains the departure.
    (package private) final String
    text
    The departure text.
    private final String
    type
    "Package", "Interface", "Class", "Method", "Field" or "Enum".
    (package private) final Name
    typeName
    Qualified name of the type, package or module that contains the departure.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DepartureElement(Element parent, com.sun.source.doctree.DocTree tag, String text)
    Stores a description for the given departure tag.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    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.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • typeName

      final Name 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

      private final String shortTypeName
      The simple name (without path or extension) of the type that contains the departure.

    • pathToHTML

      private final String pathToHTML
      Path to HTML javadoc.

    • type

      private final String type
      "Package", "Interface", "Class", "Method", "Field" or "Enum".

    • name

      private final String name
      The class or method name that contains the departure. May be the same than shortTypeName.

    • text

      final String text
      The departure text.

    • isMember

      final boolean isMember
      true if this element is for a field or method. false if this element is for an interface, class or package.

    • isPackage

      private final boolean isPackage
      true if this element is for a package.

  • Constructor Details

    • DepartureElement

      DepartureElement(Element parent, com.sun.source.doctree.DocTree tag, String text)
      Stores a description for the given departure tag.

  • Method Details