Package org.apache.maven.tools.plugin.extractor.annotations.converter.tag

Class LinkUtils

java.lang.Object

org.apache.maven.tools.plugin.extractor.annotations.converter.tag.LinkUtils

public class LinkUtils
extends java.lang.Object

Utility methods for dealing with links generated from Javadoc tags.

Field Summary

Fields

Modifier and Type	Field	Description
private static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LinkUtils()

Method Summary

Modifier and Type	Method	Description
private static java.lang.String	createLabel(java.util.Optional<java.lang.String> moduleName, java.util.Optional<java.lang.String> packageName, java.util.Optional<java.lang.String> className, java.util.Optional<java.lang.String> member)
static java.lang.String	createLink(java.lang.String referenceValue, ConverterContext context)
static java.lang.String	createLink(java.lang.String referenceValue, ConverterContext context, java.util.function.UnaryOperator<java.lang.String> labelDecorator)
private static java.lang.String	createLink(java.lang.String referenceValue, FullyQualifiedJavadocReference fqReference, ConverterContext context, java.util.function.UnaryOperator<java.lang.String> labelDecorator)
private static java.lang.String	getReferenceLabel(FullyQualifiedJavadocReference fqReference, ConverterContext context)
private static java.lang.String	getReferenceLabel(FullyQualifiedJavadocReference fqReference, ConverterContext context, java.util.function.UnaryOperator<java.lang.String> labelDecorator, java.lang.String htmlComment)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

Constructor Detail

LinkUtils

private LinkUtils()

Method Detail

createLink

public static java.lang.String createLink(java.lang.String referenceValue,
                                          ConverterContext context)

createLink

public static java.lang.String createLink(java.lang.String referenceValue,
                                          ConverterContext context,
                                          java.util.function.UnaryOperator<java.lang.String> labelDecorator)

createLink

private static java.lang.String createLink(java.lang.String referenceValue,
                                           FullyQualifiedJavadocReference fqReference,
                                           ConverterContext context,
                                           java.util.function.UnaryOperator<java.lang.String> labelDecorator)

getReferenceLabel

private static java.lang.String getReferenceLabel(FullyQualifiedJavadocReference fqReference,
                                                  ConverterContext context,
                                                  java.util.function.UnaryOperator<java.lang.String> labelDecorator,
                                                  java.lang.String htmlComment)

getReferenceLabel

private static java.lang.String getReferenceLabel(FullyQualifiedJavadocReference fqReference,
                                                  ConverterContext context)

Returns:

the undecorated label of the link

See Also:

javadoc: How a Name Appears

createLabel

private static java.lang.String createLabel(java.util.Optional<java.lang.String> moduleName,
                                            java.util.Optional<java.lang.String> packageName,
                                            java.util.Optional<java.lang.String> className,
                                            java.util.Optional<java.lang.String> member)