APIdia Launch Partner
Top Inners Constructors Methods
jdk.javadoc.internal.doclets.formats.html

public Class Signatures

extends Object
Class Inheritance
Imports
java.util.ArrayList, .List, .Set, .SortedSet, .TreeSet, java.util.stream.Collectors, javax.lang.model.element.Element, .ElementKind, .Modifier, .ModuleElement, .PackageElement, .RecordComponentElement, .TypeElement, javax.lang.model.type.TypeMirror, javax.lang.model.util.ElementKindVisitor14, jdk.javadoc.doclet.DocletEnvironment, jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyles, jdk.javadoc.internal.doclets.toolkit.util.Utils, jdk.javadoc.internal.html.Content, .ContentBuilder, .Entity, .HtmlTree, .Text

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
Signatures.MemberSignature

A content builder for member signatures.

pack-priv static class
Signatures.TypeSignature

Constructor Summary

AccessConstructor and Description
public
Signatures()

Method Summary

Modifier and TypeMethod and Description
public static Content
getModuleSignature(ModuleElement mdle, ModuleWriter moduleWriter)

public static Content
getPackageSignature(PackageElement pkg, PackageWriter pkgWriter)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Signaturesback to summary
public Signatures()

Method Detail

getModuleSignatureback to summary
public static Content getModuleSignature(ModuleElement mdle, ModuleWriter moduleWriter)
getPackageSignatureback to summary
public static Content getPackageSignature(PackageElement pkg, PackageWriter pkgWriter)
jdk.javadoc.internal.doclets.formats.html back to summary

pack-priv Class Signatures.MemberSignature

extends Object
Class Inheritance
  • java.lang.Object
  • jdk.javadoc.internal.doclets.formats.html.Signatures.MemberSignature
A content builder for member signatures.

Field Summary

Modifier and TypeField and Description
private Content
annotations

private final Element
element

private Content
exceptions

private final AbstractMemberWriter
memberWriter

private Content
parameters

private static final int
RETURN_TYPE_MAX_LINE_LENGTH

private Content
returnType

private Content
typeParameters

private final Utils
utils

Constructor Summary

AccessConstructor and Description
pack-priv
MemberSignature(Element
the element for which to create a signature
element, AbstractMemberWriter
the member writer
memberWriter)

Creates a new member signature builder.

Method Summary

Modifier and TypeMethod and Description
private void
appendModifiers(Content
the content to which the modifier information will be added
target)

Adds the modifiers for the member.

private void
appendParametersAndExceptions(Content
the HTML tree
target, int
the index of the last line separator in the HTML tree
lastLineSeparator)

Appends the parameters and exceptions information to the HTML tree.

private int

Returns:

the new index of the last line separator
appendTypeParameters(Content
the HTML tree
target, int
index of last line separator in the HTML tree
lastLineSeparator)

Appends the type parameter information to the HTML tree.

pack-priv Signatures.MemberSignature

Returns:

this instance
setAnnotations(Content
the exception information
content)

Set the annotation information of a member.

pack-priv Signatures.MemberSignature

Returns:

this instance
setExceptions(Content
the exception information
content)

Set the exception information of an executable member.

pack-priv Signatures.MemberSignature

Returns:

this instance
setParameters(Content
the parameter information.
content)

Set the parameter information of an executable member.

pack-priv Signatures.MemberSignature

Returns:

this instance
setReturnType(Content
the return type to add.
returnType)

Set the return type for an executable member.

pack-priv Signatures.MemberSignature

Returns:

this instance
setType(TypeMirror
the type of the member.
type)

Set the type information for a non-executable member.

pack-priv Signatures.MemberSignature

Returns:

this instance
setTypeParameters(Content
the type parameters to add.
typeParameters)

Set the type parameters for an executable member.

pack-priv Content

Returns:

an HTML tree containing the member signature
toContent()

Returns an HTML tree containing the member signature.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

annotationsback to summary
private Content annotations
elementback to summary
private final Element element
exceptionsback to summary
private Content exceptions
memberWriterback to summary
private final AbstractMemberWriter memberWriter
parametersback to summary
private Content parameters
RETURN_TYPE_MAX_LINE_LENGTHback to summary
private static final int RETURN_TYPE_MAX_LINE_LENGTH
returnTypeback to summary
private Content returnType
typeParametersback to summary
private Content typeParameters
utilsback to summary
private final Utils utils

Constructor Detail

MemberSignatureback to summary
pack-priv MemberSignature(Element element, AbstractMemberWriter memberWriter)

Creates a new member signature builder.

Parameters
element:Element

the element for which to create a signature

memberWriter:AbstractMemberWriter

the member writer

Method Detail

appendModifiersback to summary
private void appendModifiers(Content target)

Adds the modifiers for the member. The modifiers are ordered as specified by The Java Language Specification.

Parameters
target:Content

the content to which the modifier information will be added

appendParametersAndExceptionsback to summary
private void appendParametersAndExceptions(Content target, int lastLineSeparator)

Appends the parameters and exceptions information to the HTML tree.

Parameters
target:Content

the HTML tree

lastLineSeparator:int

the index of the last line separator in the HTML tree

appendTypeParametersback to summary
private int appendTypeParameters(Content target, int lastLineSeparator)

Appends the type parameter information to the HTML tree.

Parameters
target:Content

the HTML tree

lastLineSeparator:int

index of last line separator in the HTML tree

Returns:int

the new index of the last line separator

setAnnotationsback to summary
pack-priv Signatures.MemberSignature setAnnotations(Content content)

Set the annotation information of a member.

Parameters
content:Content

the exception information

Returns:Signatures.MemberSignature

this instance

setExceptionsback to summary
pack-priv Signatures.MemberSignature setExceptions(Content content)

Set the exception information of an executable member.

Parameters
content:Content

the exception information

Returns:Signatures.MemberSignature

this instance

setParametersback to summary
pack-priv Signatures.MemberSignature setParameters(Content content)

Set the parameter information of an executable member.

Parameters
content:Content

the parameter information.

Returns:Signatures.MemberSignature

this instance

setReturnTypeback to summary
pack-priv Signatures.MemberSignature setReturnType(Content returnType)

Set the return type for an executable member.

Parameters
returnType:Content

the return type to add.

Returns:Signatures.MemberSignature

this instance

setTypeback to summary
pack-priv Signatures.MemberSignature setType(TypeMirror type)

Set the type information for a non-executable member.

Parameters
type:TypeMirror

the type of the member.

Returns:Signatures.MemberSignature

this instance

setTypeParametersback to summary
pack-priv Signatures.MemberSignature setTypeParameters(Content typeParameters)

Set the type parameters for an executable member.

Parameters
typeParameters:Content

the type parameters to add.

Returns:Signatures.MemberSignature

this instance

toContentback to summary
pack-priv Content toContent()

Returns an HTML tree containing the member signature.

Returns:Content

an HTML tree containing the member signature

jdk.javadoc.internal.doclets.formats.html back to summary

pack-priv Class Signatures.TypeSignature

extends Object
Class Inheritance
  • java.lang.Object
  • jdk.javadoc.internal.doclets.formats.html.Signatures.TypeSignature

Field Summary

Modifier and TypeField and Description
private final HtmlConfiguration
configuration

private Content
modifiers

private static final Set<String>
previewModifiers

private final TypeElement
typeElement

private final Utils
utils

private final HtmlDocletWriter
writer

Constructor Summary

AccessConstructor and Description
pack-priv
TypeSignature(TypeElement typeElement, HtmlDocletWriter writer)

Method Summary

Modifier and TypeMethod and Description
private List<String>
getModifiers()

private Content
getRecordComponents()

private Content
markPreviewModifiers(List<String> modifiers)

public Signatures.TypeSignature
setModifiers(Content modifiers)

public Content
toContent()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

configurationback to summary
private final HtmlConfiguration configuration
modifiersback to summary
private Content modifiers
previewModifiersback to summary
private static final Set<String> previewModifiers
typeElementback to summary
private final TypeElement typeElement
utilsback to summary
private final Utils utils
writerback to summary
private final HtmlDocletWriter writer

Constructor Detail

TypeSignatureback to summary
pack-priv TypeSignature(TypeElement typeElement, HtmlDocletWriter writer)

Method Detail

getModifiersback to summary
private List<String> getModifiers()
getRecordComponentsback to summary
private Content getRecordComponents()
markPreviewModifiersback to summary
private Content markPreviewModifiers(List<String> modifiers)
setModifiersback to summary
public Signatures.TypeSignature setModifiers(Content modifiers)
toContentback to summary
public Content toContent()