Package org.apache.maven.tools.plugin.extractor.annotations.converter

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.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final Map<String,Object>	attributes
(package private) final com.thoughtworks.qdox.model.JavaClass	declaringClass
(package private) final Optional<com.thoughtworks.qdox.model.JavaModule>	javaModule
(package private) final com.thoughtworks.qdox.JavaProjectBuilder	javaProjectBuilder
(package private) final int	lineNumber
(package private) final JavadocLinkGenerator	linkGenerator
(package private) final Map<String,MojoAnnotatedClass>	mojoAnnotatedClasses
(package private) final com.thoughtworks.qdox.model.JavaClass	mojoClass

Constructor Summary

Constructors

Constructor	Description
JavaClassConverterContext(com.thoughtworks.qdox.model.JavaClass mojoClass, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, Map<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, Map<String,MojoAnnotatedClass> mojoAnnotatedClasses, JavadocLinkGenerator linkGenerator, int lineNumber)

Method Summary

Modifier and Type	Method	Description
boolean	canGetUrl()
<T> T	getAttribute(String name, Class<T> clazz, T defaultValue)	Retrieves some attribute value from the current context.
private static int	getDimensions(String type)
URI	getInternalJavadocSiteBaseUrl()	Returns the base url to use for internal javadoc links
String	getLocation()
private static String	getMethodName(String member)
Optional<String>	getModuleName()
String	getPackageName()
private List<com.thoughtworks.qdox.model.JavaType>	getParameterTypes(String member)
private static String	getRawTypeName(String typeName)
String	getStaticFieldValue(FullyQualifiedJavadocReference reference)	Returns the value of a referenced static field.
URI	getUrl(FullyQualifiedJavadocReference reference)	Returns a (deep-)link to the javadoc page for the given reference
private 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 Optional<FullyQualifiedJavadocReference>	resolveMember(com.thoughtworks.qdox.model.JavaClass javaClass, Optional<String> member, Optional<String> label)
private Optional<FullyQualifiedJavadocReference>	resolveMember(String fullyQualifiedPackageNameClassName, String nestedClassName, Optional<String> member, Optional<String> label)
private Optional<FullyQualifiedJavadocReference>	resolveMember(String fullyQualifiedPackageNameClassName, Optional<String> member, Optional<String> label)
FullyQualifiedJavadocReference	resolveReference(JavadocReference reference)	Resolves a given javadoc reference, according to the rules of Javadoc's search order.
<T> T	setAttribute(String name, T value)	Stores some attribute in the current context

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

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 Map<String,MojoAnnotatedClass> mojoAnnotatedClasses

linkGenerator

final JavadocLinkGenerator linkGenerator

lineNumber

final int lineNumber

javaModule

final Optional<com.thoughtworks.qdox.model.JavaModule> javaModule

attributes

final Map<String,Object> attributes

Constructor Details

JavaClassConverterContext

public JavaClassConverterContext(com.thoughtworks.qdox.model.JavaClass mojoClass,
 com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder,
 Map<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,
 Map<String,MojoAnnotatedClass> mojoAnnotatedClasses,
 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(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

isClassReferencedByReference

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

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(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 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 interface ConverterContext

Parameters:

reference - the reference to resolve

Returns:

the resolved fully qualified reference

getStaticFieldValue

public 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 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 Optional<FullyQualifiedJavadocReference> resolveMember(String fullyQualifiedPackageNameClassName,
 Optional<String> member,
 Optional<String> label)

resolveMember

private Optional<FullyQualifiedJavadocReference> resolveMember(String fullyQualifiedPackageNameClassName,
 String nestedClassName,
 Optional<String> member,
 Optional<String> label)

isExternal

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

isExternal

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

resolveMember

private Optional<FullyQualifiedJavadocReference> resolveMember(com.thoughtworks.qdox.model.JavaClass javaClass,
 Optional<String> member,
 Optional<String> label)

isClassFound

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

getParameterTypes

private List<com.thoughtworks.qdox.model.JavaType> getParameterTypes(String member)

getDimensions

private static int getDimensions(String type)

getRawTypeName

private static String getRawTypeName(String typeName)

getMethodName

private static String getMethodName(String member)

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

Type Parameters:

T -

Parameters:

name -

value -

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

Type Parameters:

T -

Parameters:

name -

clazz -

defaultValue -

Returns:

the value of the attribute with the given name or null if it does not exist