Modifier and Type	Class and Description
pack-priv static interface	Parser.LineConsumer
public static class	Parser.Regions
public static record	Parser.Result
pack-priv static class	Parser.Tag

Modifier and Type	Field and Description
private static final Pattern	JAVA_COMMENT
private final MarkupParser	markupParser
private static final Pattern	PROPERTIES_COMMENT
private final Parser.Regions	regions
private final Resources	resources
private final Queue<Parser.Tag>	tags

Access	Constructor and Description
public	Parser(Resources resources)

Modifier and Type	Method and Description
private void	append(StyledText text, Set<Style> style, CharSequence s)
private void	completeTag(Parser.Tag start, Parser.Tag end)
private Pattern	createRegexPattern(Optional<Attribute.Valued> substring, Optional<Attribute.Valued> regex, int offset)
private Pattern	createRegexPattern(Optional<Attribute.Valued> substring, Optional<Attribute.Valued> regex, String defaultRegex, int offset)
pack-priv static void	forEachLine(String s, Parser.LineConsumer consumer)
private ParseException	newParseException(int pos, String key, Object... args)
public Parser.Result	parse(SnippetTaglet.Diags diags, SnippetTaglet.Language language, String source)
private Parser.Result	parse(SnippetTaglet.Diags diags, Pattern commentPattern, String source)
private void	processTag(Parser.Tag t)

JAVA_COMMENT	back to summary
private static final Pattern JAVA_COMMENT

markupParser	back to summary
private final MarkupParser markupParser

PROPERTIES_COMMENT	back to summary
private static final Pattern PROPERTIES_COMMENT

regions	back to summary
private final Parser.Regions regions

resources	back to summary
private final Resources resources

tags	back to summary
private final Queue<Parser.Tag> tags

Parser	back to summary
public Parser(Resources resources)

Method Detail

append	back to summary
private void append(StyledText text, Set<Style> style, CharSequence s)

completeTag	back to summary
private void completeTag(Parser.Tag start, Parser.Tag end)

createRegexPattern	back to summary
private Pattern createRegexPattern(Optional<Attribute.Valued> substring, Optional<Attribute.Valued> regex, int offset) throws ParseException

createRegexPattern	back to summary
private Pattern createRegexPattern(Optional<Attribute.Valued> substring, Optional<Attribute.Valued> regex, String defaultRegex, int offset) throws ParseException

forEachLine	back to summary
pack-priv static void forEachLine(String s, Parser.LineConsumer consumer)

newParseException	back to summary
private ParseException newParseException(int pos, String key, Object... args)

parse	back to summary
public Parser.Result parse(SnippetTaglet.Diags diags, SnippetTaglet.Language language, String source) throws ParseException

parse	back to summary
private Parser.Result parse(SnippetTaglet.Diags diags, Pattern commentPattern, String source) throws ParseException

processTag	back to summary
private void processTag(Parser.Tag t) throws ParseException

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

pack-priv Interface Parser.LineConsumer

Annotations

@FunctionalInterface

Method Summary

Modifier and Type	Method and Description
public void	accept(int offset, String line)

Method Detail

accept	back to summary
public void accept(int offset, String line)

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

public final Class Parser.Regions

Class Inheritance

extends Object

java.lang.Object
jdk.javadoc.internal.doclets.formats.html.taglets.snippet.Parser.Regions

Field Summary

Modifier and Type	Field and Description
private final ArrayList<Map.Entry<Optional<String>, Parser.Tag>>	tags

Constructor Summary

Access	Constructor and Description
public	Regions()

Method Summary

Modifier and Type	Method and Description
pack-priv void	addAnonymous(Parser.Tag i)
pack-priv boolean	addNamed(String name, Parser.Tag i)
pack-priv void	clear()
pack-priv boolean	isEmpty()
pack-priv Optional<Parser.Tag>	removeLast()
pack-priv Optional<Parser.Tag>	removeNamed(String name)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

tags	back to summary
private final ArrayList<Map.Entry<Optional<String>, Parser.Tag>> tags

Constructor Detail

Regions	back to summary
public Regions()

Method Detail

addAnonymous	back to summary
pack-priv void addAnonymous(Parser.Tag i)

addNamed	back to summary
pack-priv boolean addNamed(String name, Parser.Tag i)

clear	back to summary
pack-priv void clear()

isEmpty	back to summary
pack-priv boolean isEmpty()

removeLast	back to summary
pack-priv Optional<Parser.Tag> removeLast()

removeNamed	back to summary
pack-priv Optional<Parser.Tag> removeNamed(String name)

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

public final Record Parser.Result

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
jdk.javadoc.internal.doclets.formats.html.taglets.snippet.Parser.Result

Record Components

text:StyledText
actions:Queue<Action>

Field Summary

Modifier and Type	Field and Description
private final Queue<Action>	actions Record Component accessed by actions().
private final StyledText	text Record Component accessed by text().

Constructor Summary

Access	Constructor and Description
public	Result(StyledText text, Queue<Action> actions)

Method Summary

Modifier and Type	Method and Description
public Queue<Action>	actions() Record Component getter of actions.
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 StyledText	text() Record Component getter of text.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

actions	back to summary
private final Queue<Action> actions Record Component accessed by actions().

text	back to summary
private final StyledText text Record Component accessed by text().

Constructor Detail

Result	back to summary
public Result(StyledText text, Queue<Action> actions)

Method Detail

actions	back to summary
public Queue<Action> actions() Record Component getter of actions.

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.

text	back to summary
public StyledText text() Record Component getter of text.

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.formats.html.taglets.snippet back to summary

pack-priv final Class Parser.Tag

Class Inheritance

extends Object

java.lang.Object
jdk.javadoc.internal.doclets.formats.html.taglets.snippet.Parser.Tag

Field Summary

Modifier and Type	Field and Description
pack-priv boolean	appliesToNextLine
pack-priv List<Attribute>	attributes
pack-priv int	end
pack-priv int	lineSourceOffset
pack-priv int	markupLineOffset
pack-priv String	name
pack-priv int	nameLineOffset
pack-priv int	start

Constructor Summary

Access	Constructor and Description
pack-priv	Tag()

Method Summary

Modifier and Type	Method and Description
pack-priv List<Attribute>	attributes()
pack-priv int	end()
pack-priv String	name()
pack-priv int	start()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

appliesToNextLine	back to summary
pack-priv boolean appliesToNextLine

attributes	back to summary
pack-priv List<Attribute> attributes

end	back to summary
pack-priv int end

lineSourceOffset	back to summary
pack-priv int lineSourceOffset

markupLineOffset	back to summary
pack-priv int markupLineOffset

name	back to summary
pack-priv String name

nameLineOffset	back to summary
pack-priv int nameLineOffset

start	back to summary
pack-priv int start

Constructor Detail

Tag	back to summary
pack-priv Tag()

Method Detail

attributes	back to summary
pack-priv List<Attribute> attributes()

end	back to summary
pack-priv int end()

name	back to summary
pack-priv String name()

start	back to summary
pack-priv int start()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public final Class Parser

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface Parser.LineConsumer

Method Summary

Method Detail

public final Class Parser.Regions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record Parser.Result

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class Parser.Tag

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail