Package org.apache.maven.tools.plugin.javadoc

Class JavadocReference

java.lang.Object

org.apache.maven.tools.plugin.javadoc.JavadocReference

Direct Known Subclasses:

FullyQualifiedJavadocReference

public class JavadocReference
extends java.lang.Object

Describes a code reference used in javadoc tags see, link and linkplain. The format of the reference given as string is module/package.class#member label. Members must be separated with a # to be detected. Targets either module, package, class or field/method/constructor in class. This class does not know whether the second part part refers to a package, class or both, as they use the same alphabet and separators.

See Also:

link tag specification

Field Summary

Fields

Modifier and Type	Field	Description
private static int	GROUP_INDEX_LABEL
private static int	GROUP_INDEX_MEMBER
private static int	GROUP_INDEX_MODULE
private static int	GROUP_INDEX_PACKAGECLASS
private java.util.Optional<java.lang.String>	label
private java.util.Optional<java.lang.String>	member
private java.util.Optional<java.lang.String>	moduleName
private java.util.Optional<java.lang.String>	packageNameClassName
private static java.util.regex.Pattern	REFERENCE_VALUE_PATTERN

Constructor Summary

Constructors

Constructor	Description
JavadocReference(java.util.Optional<java.lang.String> moduleName, java.util.Optional<java.lang.String> packageNameClassName, java.util.Optional<java.lang.String> member, java.util.Optional<java.lang.String> label)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.util.Optional<java.lang.String>	getLabel()
java.util.Optional<java.lang.String>	getMember()
java.util.Optional<java.lang.String>	getModuleName()
private static java.util.Optional<java.lang.String>	getOptionalGroup(java.util.regex.Matcher matcher, int index)
java.util.Optional<java.lang.String>	getPackageNameClassName()
int	hashCode()
static JavadocReference	parse(java.lang.String reference)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

moduleName

private final java.util.Optional<java.lang.String> moduleName

packageNameClassName

private final java.util.Optional<java.lang.String> packageNameClassName

member

private final java.util.Optional<java.lang.String> member

label

private final java.util.Optional<java.lang.String> label

REFERENCE_VALUE_PATTERN

private static final java.util.regex.Pattern REFERENCE_VALUE_PATTERN

GROUP_INDEX_MODULE

private static final int GROUP_INDEX_MODULE

See Also:

Constant Field Values

GROUP_INDEX_PACKAGECLASS

private static final int GROUP_INDEX_PACKAGECLASS

See Also:

Constant Field Values

GROUP_INDEX_MEMBER

private static final int GROUP_INDEX_MEMBER

See Also:

Constant Field Values

GROUP_INDEX_LABEL

private static final int GROUP_INDEX_LABEL

See Also:

Constant Field Values

Constructor Detail

JavadocReference

JavadocReference(java.util.Optional<java.lang.String> moduleName,
                 java.util.Optional<java.lang.String> packageNameClassName,
                 java.util.Optional<java.lang.String> member,
                 java.util.Optional<java.lang.String> label)

Method Detail

parse

public static JavadocReference parse(java.lang.String reference)

Parameters:

reference - the reference value to parse

Returns:

the created JavadocReference

Throws:

java.lang.IllegalArgumentException - in case the reference has an invalid format

getOptionalGroup

private static java.util.Optional<java.lang.String> getOptionalGroup(java.util.regex.Matcher matcher,
                                                                     int index)

getModuleName

public java.util.Optional<java.lang.String> getModuleName()

getPackageNameClassName

public java.util.Optional<java.lang.String> getPackageNameClassName()

Returns:

a package name, a class name or a package name followed by a class name

getMember

public java.util.Optional<java.lang.String> getMember()

getLabel

public java.util.Optional<java.lang.String> getLabel()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object