Class FullyQualifiedJavadocReference


  • public class FullyQualifiedJavadocReference
    extends JavadocReference
    Wraps a fully qualified (and resolved) code reference used in javadoc tags see, link and linkplain. Similar to JavadocReference 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 of FullyQualifiedJavadocReference.MemberType (in case the reference contains a member part).
    • Field Detail

      • isExternal

        private final boolean isExternal
        if false, points to a class/package which is part of the current classloader (and not any of its parents)
      • packageName

        private final java.util.Optional<java.lang.String> packageName
    • Constructor Detail

      • FullyQualifiedJavadocReference

        public FullyQualifiedJavadocReference​(java.lang.String packageName,
                                              boolean isExternal)
      • FullyQualifiedJavadocReference

        public FullyQualifiedJavadocReference​(java.lang.String packageName,
                                              java.util.Optional<java.lang.String> label,
                                              boolean isExternal)
      • FullyQualifiedJavadocReference

        public FullyQualifiedJavadocReference​(java.lang.String packageName,
                                              java.lang.String className,
                                              boolean isExternal)
      • FullyQualifiedJavadocReference

        public FullyQualifiedJavadocReference​(java.lang.String packageName,
                                              java.lang.String className,
                                              java.lang.String member,
                                              FullyQualifiedJavadocReference.MemberType memberType,
                                              boolean isExternal)
      • FullyQualifiedJavadocReference

        public FullyQualifiedJavadocReference​(java.lang.String packageName,
                                              java.util.Optional<java.lang.String> className,
                                              java.util.Optional<java.lang.String> member,
                                              java.util.Optional<FullyQualifiedJavadocReference.MemberType> memberType,
                                              java.util.Optional<java.lang.String> label,
                                              boolean isExternal)
      • FullyQualifiedJavadocReference

        public FullyQualifiedJavadocReference​(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,
                                              java.util.Optional<FullyQualifiedJavadocReference.MemberType> memberType,
                                              java.util.Optional<java.lang.String> label,
                                              boolean isExternal)
    • Method Detail

      • isExternal

        public boolean isExternal()
        Returns:
        true in case this class/package is part of another classloader
      • getPackageName

        public java.util.Optional<java.lang.String> getPackageName()
        Returns:
        the package name of the referenced class
      • getClassName

        public java.util.Optional<java.lang.String> getClassName()
        Returns:
        the simple class name of the referenced class, may be prefixed by the declaring class names, separated by '.' (for inner classes)
      • getFullyQualifiedClassName

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