Class JavaClassConverterContext
- java.lang.Object
-
- org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext
-
- All Implemented Interfaces:
ConverterContext
public class JavaClassConverterContext extends java.lang.Object implements ConverterContext
-
-
Field Summary
Fields Modifier and Type Field Description (package private) java.util.Map<java.lang.String,java.lang.Object>
attributes
(package private) com.thoughtworks.qdox.model.JavaClass
declaringClass
(package private) java.util.Optional<com.thoughtworks.qdox.model.JavaModule>
javaModule
(package private) com.thoughtworks.qdox.JavaProjectBuilder
javaProjectBuilder
(package private) int
lineNumber
(package private) JavadocLinkGenerator
linkGenerator
(package private) java.util.Map<java.lang.String,MojoAnnotatedClass>
mojoAnnotatedClasses
(package private) com.thoughtworks.qdox.model.JavaClass
mojoClass
-
Constructor Summary
Constructors Constructor Description 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(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 Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canGetUrl()
<T> T
getAttribute(java.lang.String name, java.lang.Class<T> clazz, T defaultValue)
Retrieves some attribute value from the current context.private static int
getDimensions(java.lang.String type)
java.net.URI
getInternalJavadocSiteBaseUrl()
Returns the base url to use for internal javadoc linksjava.lang.String
getLocation()
private static java.lang.String
getMethodName(java.lang.String member)
java.util.Optional<java.lang.String>
getModuleName()
java.lang.String
getPackageName()
private java.util.List<com.thoughtworks.qdox.model.JavaType>
getParameterTypes(java.lang.String member)
private static java.lang.String
getRawTypeName(java.lang.String typeName)
java.lang.String
getStaticFieldValue(FullyQualifiedJavadocReference reference)
Returns the value of a referenced static field.java.net.URI
getUrl(FullyQualifiedJavadocReference reference)
Returns a (deep-)link to the javadoc page for the given referenceprivate static boolean
isClassFound(com.thoughtworks.qdox.model.JavaClass javaClass)
private static boolean
isClassReferencedByReference(com.thoughtworks.qdox.model.JavaClass javaClass, FullyQualifiedJavadocReference reference)
private boolean
isExternal(com.thoughtworks.qdox.model.JavaClass javaClass)
private boolean
isExternal(com.thoughtworks.qdox.model.JavaPackage javaPackage)
boolean
isReferencedBy(FullyQualifiedJavadocReference reference)
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)
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)
private java.util.Optional<FullyQualifiedJavadocReference>
resolveMember(java.lang.String fullyQualifiedPackageNameClassName, java.util.Optional<java.lang.String> member, java.util.Optional<java.lang.String> label)
FullyQualifiedJavadocReference
resolveReference(JavadocReference reference)
Resolves a given javadoc reference, according to the rules of Javadoc's search order.<T> T
setAttribute(java.lang.String name, T value)
Stores some attribute in the current context
-
-
-
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
-
linkGenerator
final JavadocLinkGenerator linkGenerator
-
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 interfaceConverterContext
- Returns:
- the module name of the container class
-
getPackageName
public java.lang.String getPackageName()
- Specified by:
getPackageName
in interfaceConverterContext
- Returns:
- the package name of the container class
-
getLocation
public java.lang.String getLocation()
- Specified by:
getLocation
in interfaceConverterContext
- 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(FullyQualifiedJavadocReference reference)
- Specified by:
isReferencedBy
in interfaceConverterContext
- Parameters:
reference
-- Returns:
- true in case either the current context class or any of its super classes are referenced
-
isClassReferencedByReference
private static boolean isClassReferencedByReference(com.thoughtworks.qdox.model.JavaClass javaClass, FullyQualifiedJavadocReference reference)
-
canGetUrl
public boolean canGetUrl()
- Specified by:
canGetUrl
in interfaceConverterContext
- Returns:
true
if links to javadoc pages could potentially be generated withConverterContext.getUrl(FullyQualifiedJavadocReference)
.
-
getUrl
public java.net.URI getUrl(FullyQualifiedJavadocReference reference)
Description copied from interface:ConverterContext
Returns a (deep-)link to the javadoc page for the given reference- Specified by:
getUrl
in interfaceConverterContext
- Parameters:
reference
- the reference for which to get the url- Returns:
- the link
-
resolveReference
public FullyQualifiedJavadocReference resolveReference(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 interfaceConverterContext
- Parameters:
reference
- the reference to resolve- Returns:
- the resolved fully qualified 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 interfaceConverterContext
- 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 interfaceConverterContext
- 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 interfaceConverterContext
- 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 interfaceConverterContext
- Returns:
- the value of the attribute with the given name or
null
if it does not exist
-
-