Modifier and Type	Class and Description
private static record	DocFinder.Concluded<T>
private static record	DocFinder.Continued<T>
public static interface	DocFinder.Criterion<T, X extends Throwable>
public static class	DocFinder.NoOverriddenMethodFound
public static interface	DocFinder.Result<T>
private static record	DocFinder.Skipped<T>

Modifier and Type	Field and Description
private static final DocFinder.Result<?>	CONTINUE
private final Function<ExecutableElement, Iterable<? extends ExecutableElement>>	overriddenMethodLookup
private static final DocFinder.Result<?>	SKIP

Access	Constructor and Description
pack-priv	DocFinder(Function<ExecutableElement, Iterable<? extends ExecutableElement>> overriddenMethodLookup)

Modifier and Type	Method and Description
public <T, X extends Throwable> DocFinder.Result<T>	find(ExecutableElement method, DocFinder.Criterion<T, X> criterion)
public <T, X extends Throwable> DocFinder.Result<T>	search(ExecutableElement method, DocFinder.Criterion<T, X> criterion)
private <T, X extends Throwable> DocFinder.Result<T>	search0(ExecutableElement method, boolean includeMethodInSearch, boolean throwExceptionIfDoesNotOverride, DocFinder.Criterion<T, X> criterion)

CONTINUE	back to summary
private static final DocFinder.Result<?> CONTINUE

overriddenMethodLookup	back to summary
private final Function<ExecutableElement, Iterable<? extends ExecutableElement>> overriddenMethodLookup

SKIP	back to summary
private static final DocFinder.Result<?> SKIP

DocFinder	back to summary
pack-priv DocFinder(Function<ExecutableElement, Iterable<? extends ExecutableElement>> overriddenMethodLookup)

find	back to summary
public <T, X extends Throwable> DocFinder.Result<T> find(ExecutableElement method, DocFinder.Criterion<T, X> criterion) throws NoOverriddenMethodFound, Criterion-:X

search	back to summary
public <T, X extends Throwable> DocFinder.Result<T> search(ExecutableElement method, DocFinder.Criterion<T, X> criterion) throws Criterion-:X

search0	back to summary
private <T, X extends Throwable> DocFinder.Result<T> search0(ExecutableElement method, boolean includeMethodInSearch, boolean throwExceptionIfDoesNotOverride, DocFinder.Criterion<T, X> criterion) throws NoOverriddenMethodFound, Criterion-:X

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

private final Record DocFinder.Concluded<T>

Class Inheritance

extends Record
implements DocFinder.Result.Conclude<T>

java.lang.Object
java.lang.Record
jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Concluded

All Implemented Interfaces

jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result.Conclude, jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result

Record Components

value:T

Field Summary

Modifier and Type	Field and Description
private final T	value Record Component accessed by value().

Constructor Summary

Access	Constructor and Description
pack-priv	Concluded(T value)

Method Summary

Modifier and Type	Method and Description
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 Optional<T>	toOptional() Overrides default jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result.toOptional.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public T	value() Record Component getter of value. Implements jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result.Conclude.value.

Field Detail

value	back to summary
private final T value Record Component accessed by value().

Constructor Detail

Concluded	back to summary
pack-priv Concluded(T value)

Method Detail

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.

toOptional	back to summary
public Optional<T> toOptional() Overrides default jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result.toOptional. Annotations @Override

toOptional

back to summary

public Optional<T> toOptional()

Overrides default jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result.toOptional.

Annotations

@Override

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.

value	back to summary
public T value() Record Component getter of value. Implements jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result.Conclude.value.

value

back to summary

public T value()

Record Component getter of value.

Implements jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result.Conclude.value.

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

private final Record DocFinder.Continued<T>

Class Inheritance

extends Record
implements DocFinder.Result.Continue<T>

java.lang.Object
java.lang.Record
jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Continued

All Implemented Interfaces

jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result.Continue, jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result

Record Components

no record components

Constructor Summary

Access	Constructor and Description
private	Continued()

Method Summary

Modifier and Type	Method and Description
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 final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Constructor Detail

Continued	back to summary
private Continued()

Method Detail

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.

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.

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

public Interface DocFinder.Criterion<T, X extends Throwable>

Annotations

@FunctionalInterface

Method Summary

Modifier and Type	Method and Description
public DocFinder.Result<T>	apply(ExecutableElement method)

Method Detail

apply	back to summary
public DocFinder.Result<T> apply(ExecutableElement method) throws Criterion:X

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

public final Class DocFinder.NoOverriddenMethodFound

Class Inheritance

extends Exception

java.lang.Object
java.lang.Throwable
java.lang.Exception
jdk.javadoc.internal.doclets.toolkit.util.DocFinder.NoOverriddenMethodFound

Annotations

@SuppressWarnings:serial

Constructor Summary

Access	Constructor and Description
private	NoOverriddenMethodFound()

Constructor Detail

NoOverriddenMethodFound	back to summary
private NoOverriddenMethodFound()

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

public sealed Interface DocFinder.Result<T>

Known Direct Subinterfaces: jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result.Skip, jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result.Continue, jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result.Conclude

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	DocFinder.Result.Conclude<T>
public static interface	DocFinder.Result.Continue<T>
public static interface	DocFinder.Result.Skip<T>

Method Summary

Modifier and Type	Method and Description
public static <T> DocFinder.Result<T>	CONCLUDE(T value)
public static <T> DocFinder.Result<T>	CONTINUE()
public static <T> DocFinder.Result<T>	fromOptional(Optional<T> optional)
public static <T> DocFinder.Result<T>	SKIP()
public default Optional<T>	toOptional()

Method Detail

CONCLUDE	back to summary
public static <T> DocFinder.Result<T> CONCLUDE(T value)

CONTINUE	back to summary
public static <T> DocFinder.Result<T> CONTINUE() Annotations @SuppressWarnings:unchecked

fromOptional	back to summary
public static <T> DocFinder.Result<T> fromOptional(Optional<T> optional)

SKIP	back to summary
public static <T> DocFinder.Result<T> SKIP() Annotations @SuppressWarnings:unchecked

toOptional	back to summary
public default Optional<T> toOptional()

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

public sealed Interface DocFinder.Result.Conclude<T>

Known Direct Implementers: jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Concluded

Method Summary

Modifier and Type	Method and Description
public T	value()

Inherited from jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result:: CONCLUDE CONTINUE fromOptional SKIP toOptional

Method Detail

value	back to summary
public T value()

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

public sealed Interface DocFinder.Result.Continue<T>

Known Direct Implementers: jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Continued

Method Summary

Inherited from jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result:: CONCLUDE CONTINUE fromOptional SKIP toOptional

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

public sealed Interface DocFinder.Result.Skip<T>

Known Direct Implementers: jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Skipped

Method Summary

Inherited from jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result:: CONCLUDE CONTINUE fromOptional SKIP toOptional

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

private final Record DocFinder.Skipped<T>

Class Inheritance

extends Record
implements DocFinder.Result.Skip<T>

java.lang.Object
java.lang.Record
jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Skipped

All Implemented Interfaces

jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result.Skip, jdk.javadoc.internal.doclets.toolkit.util.DocFinder.Result

Record Components

no record components

Constructor Summary

Access	Constructor and Description
private	Skipped()

Method Summary

Modifier and Type	Method and Description
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 final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Constructor Detail

Skipped	back to summary
private Skipped()

Method Detail

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.

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 DocFinder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record DocFinder.Concluded<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record DocFinder.Continued<T>

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Interface DocFinder.Criterion<T, X extends Throwable>

Method Summary

Method Detail

public final Class DocFinder.NoOverriddenMethodFound

Constructor Summary

Constructor Detail

public sealed Interface DocFinder.Result<T>

Nested and Inner Type Summary

Method Summary

Method Detail

public sealed Interface DocFinder.Result.Conclude<T>

Method Summary

Method Detail

public sealed Interface DocFinder.Result.Continue<T>

Method Summary

public sealed Interface DocFinder.Result.Skip<T>

Method Summary

private final Record DocFinder.Skipped<T>

Constructor Summary

Method Summary

Constructor Detail

Method Detail