Class JavaClassConverterContext

    • Field Detail

      • mojoClass

        final com.thoughtworks.qdox.model.JavaClass mojoClass
      • declaringClass

        final com.thoughtworks.qdox.model.JavaClass declaringClass
      • javaProjectBuilder

        final com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder
      • mojoAnnotatedClasses

        final java.util.Map<java.lang.String,​MojoAnnotatedClass> mojoAnnotatedClasses
      • lineNumber

        final int lineNumber
      • javaModule

        final java.util.Optional<com.thoughtworks.qdox.model.JavaModule> javaModule
      • attributes

        final java.util.Map<java.lang.String,​java.lang.Object> attributes
    • Constructor Detail

      • JavaClassConverterContext

        public JavaClassConverterContext​(com.thoughtworks.qdox.model.JavaClass mojoClass,
                                         com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder,
                                         java.util.Map<java.lang.String,​MojoAnnotatedClass> mojoAnnotatedClasses,
                                         JavadocLinkGenerator linkGenerator,
                                         int lineNumber)
      • JavaClassConverterContext

        public JavaClassConverterContext​(com.thoughtworks.qdox.model.JavaClass mojoClass,
                                         com.thoughtworks.qdox.model.JavaClass declaringClass,
                                         com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder,
                                         java.util.Map<java.lang.String,​MojoAnnotatedClass> mojoAnnotatedClasses,
                                         JavadocLinkGenerator linkGenerator,
                                         int lineNumber)
    • Method Detail

      • getModuleName

        public java.util.Optional<java.lang.String> getModuleName()
        Specified by:
        getModuleName in interface ConverterContext
        Returns:
        the module name of the container class
      • getPackageName

        public java.lang.String getPackageName()
        Specified by:
        getPackageName in interface ConverterContext
        Returns:
        the package name of the container class
      • getLocation

        public java.lang.String getLocation()
        Specified by:
        getLocation in interface ConverterContext
        Returns:
        a location text (human readable) indicating where in the container class the conversion is triggered (should be as specific as possible to ease debugging)
      • isClassReferencedByReference

        private static boolean isClassReferencedByReference​(com.thoughtworks.qdox.model.JavaClass javaClass,
                                                            FullyQualifiedJavadocReference reference)
      • getStaticFieldValue

        public java.lang.String getStaticFieldValue​(FullyQualifiedJavadocReference reference)
        Description copied from interface: ConverterContext
        Returns the value of a referenced static field.
        Specified by:
        getStaticFieldValue in interface ConverterContext
        Parameters:
        reference - the code reference towards a static field
        Returns:
        the value of the static field given by the reference
      • getInternalJavadocSiteBaseUrl

        public java.net.URI getInternalJavadocSiteBaseUrl()
        Description copied from interface: ConverterContext
        Returns the base url to use for internal javadoc links
        Specified by:
        getInternalJavadocSiteBaseUrl in interface ConverterContext
        Returns:
        the base url for internal javadoc links (may be null).
      • resolveMember

        private java.util.Optional<FullyQualifiedJavadocReference> resolveMember​(java.lang.String fullyQualifiedPackageNameClassName,
                                                                                 java.util.Optional<java.lang.String> member,
                                                                                 java.util.Optional<java.lang.String> label)
      • resolveMember

        private java.util.Optional<FullyQualifiedJavadocReference> resolveMember​(java.lang.String fullyQualifiedPackageNameClassName,
                                                                                 java.lang.String nestedClassName,
                                                                                 java.util.Optional<java.lang.String> member,
                                                                                 java.util.Optional<java.lang.String> label)
      • isExternal

        private boolean isExternal​(com.thoughtworks.qdox.model.JavaClass javaClass)
      • isExternal

        private boolean isExternal​(com.thoughtworks.qdox.model.JavaPackage javaPackage)
      • resolveMember

        private java.util.Optional<FullyQualifiedJavadocReference> resolveMember​(com.thoughtworks.qdox.model.JavaClass javaClass,
                                                                                 java.util.Optional<java.lang.String> member,
                                                                                 java.util.Optional<java.lang.String> label)
      • isClassFound

        private static boolean isClassFound​(com.thoughtworks.qdox.model.JavaClass javaClass)
      • getParameterTypes

        private java.util.List<com.thoughtworks.qdox.model.JavaType> getParameterTypes​(java.lang.String member)
      • getDimensions

        private static int getDimensions​(java.lang.String type)
      • getRawTypeName

        private static java.lang.String getRawTypeName​(java.lang.String typeName)
      • getMethodName

        private static java.lang.String getMethodName​(java.lang.String member)
      • setAttribute

        public <T> T setAttribute​(java.lang.String name,
                                  T value)
        Description copied from interface: ConverterContext
        Stores some attribute in the current context
        Specified by:
        setAttribute in interface ConverterContext
        Returns:
        the old attribute value or null.
      • getAttribute

        public <T> T getAttribute​(java.lang.String name,
                                  java.lang.Class<T> clazz,
                                  T defaultValue)
        Description copied from interface: ConverterContext
        Retrieves some attribute value from the current context.
        Specified by:
        getAttribute in interface ConverterContext
        Returns:
        the value of the attribute with the given name or null if it does not exist