Package com.puppycrawl.tools.checkstyle.site

Class NotesMacro

java.lang.Object

org.apache.maven.doxia.macro.AbstractMacro

com.puppycrawl.tools.checkstyle.site.NotesMacro

All Implemented Interfaces:

org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.macro.Macro

@Component(role=org.apache.maven.doxia.macro.Macro.class,
           hint="notes")
public class NotesMacro
extends org.apache.maven.doxia.macro.AbstractMacro

A macro that inserts a notes subsection of module from its Javadoc.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Set<String>	HTML_TEXT_FORMAT_TAGS	A set of all html tags that need to be considered as text formatting for this macro.
private static final String	INDENT_LEVEL_10	A newline with 10 spaces of indentation.
private static final String	INDENT_LEVEL_8	A newline with 8 spaces of indentation.
private static final String	NEWLINE	New line escape character.
static final String	NOTES	"Notes:" javadoc marking.
static final Pattern	NOTES_LINE	"Notes:" line.
static final Pattern	NOTES_LINE_WITH_NEWLINE	"Notes:" line with new line accounted.

Fields inherited from interface org.apache.maven.doxia.macro.Macro

EOL, ROLE

Constructor Summary

Constructors

Constructor	Description
NotesMacro()

Method Summary

Modifier and Type	Method	Description
void	execute(org.apache.maven.doxia.sink.Sink sink, org.apache.maven.doxia.macro.MacroRequest request)
private static Optional<DetailNode>	getLiTagNode(DetailNode htmlElement)	Gets the node of Li HTML tag.
private static int	getNotesEndIndex(DetailNode moduleJavadoc, Set<String> propertyNamesSet)	Gets the end index of the Notes.
static int	getNotesStartIndex(DetailNode moduleJavadoc)	Gets the start index of the Notes section.
private static int	getParentSectionStartIndex(DetailNode moduleJavadoc)	Gets the start index of the parent subsection in module's JavaDoc.
private static Set<String>	getPropertyNames(String moduleName)	Gets properties of the specified module.
private static boolean	hasHtmlTagToStoreNotesSection(DetailNode htmlElement)	Checks whether html element has tag that stores notes section data.
private static boolean	startsWithTextFormattingHtmlTag(String line)	Checks if given line starts with HTML text-formatting tag.
private static void	writeOutNotes(String notes, org.apache.maven.doxia.sink.Sink sink)	Writes the notes into xdoc.

Methods inherited from class org.apache.maven.doxia.macro.AbstractMacro

enableLogging, getAttributesFromMap, getLog, required

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NOTES

public static final String NOTES

"Notes:" javadoc marking.

See Also:

• Constant Field Values

NOTES_LINE_WITH_NEWLINE

public static final Pattern NOTES_LINE_WITH_NEWLINE

"Notes:" line with new line accounted.

NOTES_LINE

public static final Pattern NOTES_LINE

"Notes:" line.

NEWLINE

private static final String NEWLINE

New line escape character.

See Also:

• Constant Field Values

INDENT_LEVEL_8

private static final String INDENT_LEVEL_8

A newline with 8 spaces of indentation.

INDENT_LEVEL_10

private static final String INDENT_LEVEL_10

A newline with 10 spaces of indentation.

HTML_TEXT_FORMAT_TAGS

private static final Set<String> HTML_TEXT_FORMAT_TAGS

A set of all html tags that need to be considered as text formatting for this macro.

Constructor Details

NotesMacro

public NotesMacro()

Method Details

execute

public void execute(org.apache.maven.doxia.sink.Sink sink,
 org.apache.maven.doxia.macro.MacroRequest request)
             throws org.apache.maven.doxia.macro.MacroExecutionException

Throws:

org.apache.maven.doxia.macro.MacroExecutionException

getPropertyNames

private static Set<String> getPropertyNames(String moduleName)
                                     throws org.apache.maven.doxia.macro.MacroExecutionException

Gets properties of the specified module.

Parameters:

moduleName - name of module.

Returns:

set of properties name if present, otherwise null.

Throws:

org.apache.maven.doxia.macro.MacroExecutionException - if the module could not be retrieved.

getNotesStartIndex

public static int getNotesStartIndex(DetailNode moduleJavadoc)

Gets the start index of the Notes section.

Parameters:

moduleJavadoc - javadoc of module.

Returns:

start index.

hasHtmlTagToStoreNotesSection

private static boolean hasHtmlTagToStoreNotesSection(DetailNode htmlElement)

Checks whether html element has tag that stores notes section data.

Parameters:

htmlElement - html element to check.

Returns:

true if html element has tag storing notes section, otherwise false.

getLiTagNode

private static Optional<DetailNode> getLiTagNode(DetailNode htmlElement)

Gets the node of Li HTML tag.

Parameters:

htmlElement - html element to get li tag from.

Returns:

Optional of li tag node.

getNotesEndIndex

private static int getNotesEndIndex(DetailNode moduleJavadoc,
 Set<String> propertyNamesSet)

Gets the end index of the Notes.

Parameters:

moduleJavadoc - javadoc of module.

propertyNamesSet - Set with property names.

Returns:

the end index.

getParentSectionStartIndex

private static int getParentSectionStartIndex(DetailNode moduleJavadoc)

Gets the start index of the parent subsection in module's JavaDoc.

Parameters:

moduleJavadoc - javadoc of module.

Returns:

start index of parent subsection.

writeOutNotes

private static void writeOutNotes(String notes,
 org.apache.maven.doxia.sink.Sink sink)

Writes the notes into xdoc.

Parameters:

notes - notes of the module.

sink - sink of the macro.

startsWithTextFormattingHtmlTag

private static boolean startsWithTextFormattingHtmlTag(String line)

Checks if given line starts with HTML text-formatting tag.

Parameters:

line - line to check on.

Returns:

whether given line starts with HTML text-formatting tag.