Class JavaClassConverterContext

java.lang.Object
org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext
All Implemented Interfaces:
ConverterContext

public class JavaClassConverterContext extends Object implements ConverterContext
ConverterContext based on QDox's JavaClass and JavaProjectBuilder.
  • Constructor Details

    • JavaClassConverterContext

      public JavaClassConverterContext(com.thoughtworks.qdox.model.JavaClass mojoClass, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, Map<String,MojoAnnotatedClass> mojoAnnotatedClasses, org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator linkGenerator, int lineNumber)
    • JavaClassConverterContext

      public JavaClassConverterContext(com.thoughtworks.qdox.model.JavaClass mojoClass, com.thoughtworks.qdox.model.JavaClass declaringClass, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, Map<String,MojoAnnotatedClass> mojoAnnotatedClasses, org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator linkGenerator, int lineNumber)
  • Method Details

    • getModuleName

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

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

      public 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)
    • isReferencedBy

      public boolean isReferencedBy(org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference reference)
      Specified by:
      isReferencedBy in interface ConverterContext
      Parameters:
      reference -
      Returns:
      true in case either the current context class or any of its super classes are referenced
    • canGetUrl

      public boolean canGetUrl()
      Specified by:
      canGetUrl in interface ConverterContext
      Returns:
      true if links to javadoc pages could potentially be generated with ConverterContext.getUrl(FullyQualifiedJavadocReference).
    • getUrl

      public URI getUrl(org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference reference)
      Description copied from interface: ConverterContext
      Returns a (deep-)link to the javadoc page for the given reference
      Specified by:
      getUrl in interface ConverterContext
      Parameters:
      reference - the reference for which to get the url
      Returns:
      the link
    • resolveReference

      public org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference resolveReference(org.apache.maven.tools.plugin.javadoc.JavadocReference reference)
      Description copied from interface: ConverterContext
      Resolves a given javadoc reference, according to the rules of Javadoc's search order.
      Specified by:
      resolveReference in interface ConverterContext
      Parameters:
      reference - the reference to resolve
      Returns:
      the resolved fully qualified reference
    • getStaticFieldValue

      public String getStaticFieldValue(org.apache.maven.tools.plugin.javadoc.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 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).
    • setAttribute

      public <T> T setAttribute(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(String name, 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