Package org.opengis.tools.taglet
Class Departure
java.lang.Object
org.opengis.tools.taglet.AbstractTaglet
org.opengis.tools.taglet.Departure
- All Implemented Interfaces:
Flushable
,jdk.javadoc.doclet.Taglet
The
@departure
tag for documenting the reasons for a departure from OGC/ISO standard.
The first word after the tag must be the departure category, one of:
constraint
- Some departure are required because of Java language constraint. The most common case is the mapping of theunion
construct, which exists in C/C++ but not in Java.integration
- the departure exists for better integration with standard Java library.generalization
- the departure exists in order to generalize an aspect of the specification.historic
- the departure exists for historical version (e.g. for compatibility with previous GeoAPI version).rename
- the departure is a method renaming for better compliance with Java usage, without any change in the method purpose, arguments and return type.
- Since:
- 2.3
- Version:
- 3.0.2
-
Nested Class Summary
Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Taglet
jdk.javadoc.doclet.Taglet.Location
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe allowed departure categories.private final Map
<String, List<DepartureElement>> All departures declared in javadoc tags. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
flush()
Writes to the disk all information collected during the javadoc generation.getName()
Returns the name of this custom tag.void
init
(jdk.javadoc.doclet.DocletEnvironment env, jdk.javadoc.doclet.Doclet doclet) Invoked when the doclet initializes this taglet.Given a list ofDocTree
s representing this custom tag, returns its string representation.Methods inherited from class org.opengis.tools.taglet.AbstractTaglet
getAllowedLocations, isInlineTag, print, text
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jdk.javadoc.doclet.Taglet
isBlockTag
-
Field Details
-
CATEGORIES
The allowed departure categories. Keys are the departure keyword, and values are descriptions of that departure category. The order of elements is the order of sections to be produced byinvalid reference
#summary
-
departures
All departures declared in javadoc tags. The keys are the category, and the value is a list of departure for that category.
-
-
Constructor Details
-
Departure
public Departure()Constructs a@departure
taglet.
-
-
Method Details
-
init
public void init(jdk.javadoc.doclet.DocletEnvironment env, jdk.javadoc.doclet.Doclet doclet) Invoked when the doclet initializes this taglet. This method registers this taglet for execution of theflush()
method after the doclet finished to generate all the javadoc.- Specified by:
init
in interfacejdk.javadoc.doclet.Taglet
- Overrides:
init
in classAbstractTaglet
- Parameters:
env
- the environment in which the doclet and taglet are running.doclet
- the doclet that instantiated this taglet.
-
getName
Returns the name of this custom tag.- Specified by:
getName
in interfacejdk.javadoc.doclet.Taglet
- Returns:
- the tag name.
-
toString
Given a list ofDocTree
s representing this custom tag, returns its string representation.- Specified by:
toString
in interfacejdk.javadoc.doclet.Taglet
- Parameters:
tags
- the tags to format.element
- the element to which the enclosing comment belongs.- Returns:
- a string representation of the given tags.
-
flush
Writes to the disk all information collected during the javadoc generation. In the case of this taglet, this method generates a summary of all departures. This method does nothing if there is no reported departures.- Specified by:
flush
in interfaceFlushable
- Throws:
IOException
- if an error occurred while writing the summary page.
-