Class FullyQualifiedJavadocReference
- java.lang.Object
-
- org.apache.maven.tools.plugin.javadoc.JavadocReference
-
- org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference
-
public class FullyQualifiedJavadocReference extends JavadocReference
Wraps a fully qualified (and resolved) code reference used in javadoc tagssee
,link
andlinkplain
. Similar toJavadocReference
but can distinguish between package names and class names. The package name is always set for a resolved reference (except for references to modules). The member is always the normalized form containing only fully qualified type names (without argument names), separated by,
without any whitespace characters. Also the member type is always resolved to one ofFullyQualifiedJavadocReference.MemberType
(in case the reference contains a member part).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FullyQualifiedJavadocReference.MemberType
The type of the member part of the reference.
-
Constructor Summary
Constructors Constructor Description FullyQualifiedJavadocReference(String packageName, boolean isExternal)
FullyQualifiedJavadocReference(String packageName, String className, boolean isExternal)
FullyQualifiedJavadocReference(String packageName, String className, String member, FullyQualifiedJavadocReference.MemberType memberType, boolean isExternal)
FullyQualifiedJavadocReference(String packageName, Optional<String> label, boolean isExternal)
FullyQualifiedJavadocReference(String packageName, Optional<String> className, Optional<String> member, Optional<FullyQualifiedJavadocReference.MemberType> memberType, Optional<String> label, boolean isExternal)
FullyQualifiedJavadocReference(Optional<String> moduleName, Optional<String> packageName, Optional<String> className, Optional<String> member, Optional<FullyQualifiedJavadocReference.MemberType> memberType, Optional<String> label, boolean isExternal)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
Optional<String>
getClassName()
Optional<String>
getFullyQualifiedClassName()
Optional<FullyQualifiedJavadocReference.MemberType>
getMemberType()
Optional<String>
getPackageName()
int
hashCode()
boolean
isExternal()
String
toString()
-
Methods inherited from class org.apache.maven.tools.plugin.javadoc.JavadocReference
getLabel, getMember, getModuleName, getPackageNameClassName, parse
-
-
-
-
Constructor Detail
-
FullyQualifiedJavadocReference
public FullyQualifiedJavadocReference(String packageName, boolean isExternal)
-
FullyQualifiedJavadocReference
public FullyQualifiedJavadocReference(String packageName, Optional<String> label, boolean isExternal)
-
FullyQualifiedJavadocReference
public FullyQualifiedJavadocReference(String packageName, String className, boolean isExternal)
-
FullyQualifiedJavadocReference
public FullyQualifiedJavadocReference(String packageName, String className, String member, FullyQualifiedJavadocReference.MemberType memberType, boolean isExternal)
-
FullyQualifiedJavadocReference
public FullyQualifiedJavadocReference(String packageName, Optional<String> className, Optional<String> member, Optional<FullyQualifiedJavadocReference.MemberType> memberType, Optional<String> label, boolean isExternal)
-
-
Method Detail
-
isExternal
public boolean isExternal()
- Returns:
true
in case this class/package is part of another classloader
-
getPackageName
public Optional<String> getPackageName()
- Returns:
- the package name of the referenced class
-
getClassName
public Optional<String> getClassName()
- Returns:
- the simple class name of the referenced class, may be prefixed by the declaring class names, separated by '.' (for inner classes)
-
getMemberType
public Optional<FullyQualifiedJavadocReference.MemberType> getMemberType()
- Returns:
- the type of the member. Only empty if no member is set.
-
getFullyQualifiedClassName
public Optional<String> getFullyQualifiedClassName()
-
toString
public String toString()
- Overrides:
toString
in classJavadocReference
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classJavadocReference
-
equals
public boolean equals(Object obj)
- Overrides:
equals
in classJavadocReference
-
-