Modifier and Type	Class and Description
public static record	PreviewAPIListBuilder.JEP The JEP for a preview feature in this release.

Modifier and Type	Field and Description
private final Map<Element, PreviewAPIListBuilder.JEP>	elementJeps
private final SortedSet<Element>	elementNotes
private final Map<String, PreviewAPIListBuilder.JEP>	jeps
public final String	previewFeatureTag
private final String	previewNoteTag

Access	Constructor and Description
public	PreviewAPIListBuilder(BaseConfiguration the current configuration of the doclet configuration) Constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	belongsToSummary(Element element) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.SummaryAPIListBuilder.belongsToSummary. This method decides whether Element `element` should be included in this summary list.
private void	buildPreviewFeatureInfo()
private PreviewAPIListBuilder.JEP	findJEP(UnknownInlineTagTree tag)
private <R> R	getAnnotationElementValue(Map<? extends ExecutableElement, ? extends AnnotationValue> values, String name, R defaultValue)
public SortedSet<Element>	Returns: a sorted set containing elements tagged with preview notes getElementNotes() Returns a sorted set containing elements tagged with preview notes.
public PreviewAPIListBuilder.JEP	Returns: the JEP for a preview element getJEP(Element e) Returns the JEP for a preview element.
public Set<PreviewAPIListBuilder.JEP>	Returns: a sorted set of preview feature JEPs in this release getJEPs() Returns a sorted set of preview feature JEPs in this release.

Inherited from jdk.javadoc.internal.doclets.toolkit.util.SummaryAPIListBuilder:: buildSummaryAPIInfo createSummarySet getSet handleElement hasDocumentation isEmpty

Field Detail

elementJeps	back to summary
private final Map<Element, PreviewAPIListBuilder.JEP> elementJeps

elementNotes	back to summary
private final SortedSet<Element> elementNotes

jeps	back to summary
private final Map<String, PreviewAPIListBuilder.JEP> jeps

previewFeatureTag	back to summary
public final String previewFeatureTag

previewNoteTag	back to summary
private final String previewNoteTag

Constructor Detail

PreviewAPIListBuilder	back to summary
public PreviewAPIListBuilder(BaseConfiguration configuration) Constructor. Parameters configuration:BaseConfiguration the current configuration of the doclet

PreviewAPIListBuilder

back to summary

public PreviewAPIListBuilder(BaseConfiguration configuration)

Constructor.

Parameters

configuration:BaseConfiguration: the current configuration of the doclet

Method Detail

belongsToSummary back to summary

belongsToSummary	back to summary
protected boolean belongsToSummary(Element element) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.SummaryAPIListBuilder.belongsToSummary. Doc from jdk.javadoc.internal.doclets.toolkit.util.SummaryAPIListBuilder.belongsToSummary. This method decides whether Element `element` should be included in this summary list. Annotations @Override

protected boolean belongsToSummary(Element element)

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.SummaryAPIListBuilder.belongsToSummary.

Doc from jdk.javadoc.internal.doclets.toolkit.util.SummaryAPIListBuilder.belongsToSummary.

This method decides whether Element element should be included in this summary list.

Annotations

@Override

buildPreviewFeatureInfo	back to summary
private void buildPreviewFeatureInfo()

findJEP	back to summary
private PreviewAPIListBuilder.JEP findJEP(UnknownInlineTagTree tag)

getAnnotationElementValue	back to summary
private <R> R getAnnotationElementValue(Map<? extends ExecutableElement, ? extends AnnotationValue> values, String name, R defaultValue) Annotations @SuppressWarnings:unchecked

getElementNotes	back to summary
public SortedSet<Element> getElementNotes() Returns a sorted set containing elements tagged with preview notes. Returns:SortedSet<Element> a sorted set containing elements tagged with preview notes

getElementNotes

back to summary

public SortedSet<Element> getElementNotes()

Returns a sorted set containing elements tagged with preview notes.

Returns:SortedSet<Element>: a sorted set containing elements tagged with preview notes

getJEP	back to summary
public PreviewAPIListBuilder.JEP getJEP(Element e) Returns the JEP for a preview element. Returns:PreviewAPIListBuilder.JEP the JEP for a preview element

getJEP

back to summary

public PreviewAPIListBuilder.JEP getJEP(Element e)

Returns the JEP for a preview element.

Returns:PreviewAPIListBuilder.JEP: the JEP for a preview element

getJEPs	back to summary
public Set<PreviewAPIListBuilder.JEP> getJEPs() Returns a sorted set of preview feature JEPs in this release. Returns:Set<PreviewAPIListBuilder.JEP> a sorted set of preview feature JEPs in this release

getJEPs

back to summary

public Set<PreviewAPIListBuilder.JEP> getJEPs()

Returns a sorted set of preview feature JEPs in this release.

Returns:Set<PreviewAPIListBuilder.JEP>: a sorted set of preview feature JEPs in this release

jdk.javadoc.internal.doclets.toolkit.util back to summary

public final Record PreviewAPIListBuilder.JEP

Class Inheritance

extends Record
implements Comparable<PreviewAPIListBuilder.JEP>

java.lang.Object
java.lang.Record
jdk.javadoc.internal.doclets.toolkit.util.PreviewAPIListBuilder.JEP

All Implemented Interfaces

java.lang.Comparable

Record Components

number:int
title:String
status:String

The JEP for a preview feature in this release.

Field Summary

Modifier and Type	Field and Description
private final int	number Record Component accessed by number().
private final String	status Record Component accessed by status().
private final String	title Record Component accessed by title().

Constructor Summary

Access	Constructor and Description
public	JEP(int number, String title, String status)

Method Summary

Modifier and Type	Method and Description
public int	compareTo(PreviewAPIListBuilder.JEP o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public int	number() Record Component getter of number.
public String	status() Record Component getter of status.
public String	title() Record Component getter of title.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

number	back to summary
private final int number Record Component accessed by number().

status	back to summary
private final String status Record Component accessed by status().

title	back to summary
private final String title Record Component accessed by title().

Constructor Detail

JEP	back to summary
public JEP(int number, String title, String status)

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(PreviewAPIListBuilder.JEP o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Annotations @Override

public int compareTo(PreviewAPIListBuilder.JEP o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations

@Override

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

number	back to summary
public int number() Record Component getter of number.

status	back to summary
public String status() Record Component getter of status.

title	back to summary
public String title() Record Component getter of title.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public Class PreviewAPIListBuilder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record PreviewAPIListBuilder.JEP

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail