JavadocReference (Maven Plugin Tools Extractor API 3.12.0 API)

java.lang.Object
- org.apache.maven.tools.plugin.javadoc.JavadocReference

Direct Known Subclasses:

FullyQualifiedJavadocReference
```
public class JavadocReference
extends 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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`Optional<String>`	`getLabel()`
`Optional<String>`	`getMember()`
`Optional<String>`	`getModuleName()`
`Optional<String>`	`getPackageNameClassName()`
`int`	`hashCode()`
`static JavadocReference`	`parse(String reference)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - parse
```
public static JavadocReference parse(String reference)
```
    Parameters:
    
    reference - the reference value to parse
    
    Returns:
    
    the created JavadocReference
    
    Throws:
    
    IllegalArgumentException - in case the reference has an invalid format
  - getModuleName
```
public Optional<String> getModuleName()
```
  - getPackageNameClassName
```
public Optional<String> getPackageNameClassName()
```
    Returns:
    
    a package name, a class name or a package name followed by a class name
  - getMember
```
public Optional<String> getMember()
```
  - getLabel
```
public Optional<String> getLabel()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object