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

Class SimpleConverterContext

java.lang.Object

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

All Implemented Interfaces:

ConverterContext

public class SimpleConverterContext
extends Object
implements ConverterContext

Simple converter not leveraging actual Java classes only for testing purposes. Only generates internal FullyQualifiedJavadocReferences.

Constructor Summary

Constructors

Constructor	Description
SimpleConverterContext(String packageName, URI javadocBaseUrl, org.apache.maven.tools.plugin.javadoc.JavadocReference... unresolvableReferences)
SimpleConverterContext(String packageName, Function<org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference,URI> urlSupplier, org.apache.maven.tools.plugin.javadoc.JavadocReference... unresolvableReferences)

Method Summary

Modifier and Type	Method	Description
boolean	canGetUrl()
<T> T	getAttribute(String name, Class<T> clazz, T defaultValue)
URI	getInternalJavadocSiteBaseUrl()
String	getLocation()
Optional<String>	getModuleName()
String	getPackageName()
String	getStaticFieldValue(org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference reference)
URI	getUrl(org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference reference)
boolean	isReferencedBy(org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference reference)
org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference	resolveReference(org.apache.maven.tools.plugin.javadoc.JavadocReference reference)
<T> T	setAttribute(String name, T value)

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleConverterContext

public SimpleConverterContext(String packageName,
 URI javadocBaseUrl,
 org.apache.maven.tools.plugin.javadoc.JavadocReference... unresolvableReferences)

SimpleConverterContext

public SimpleConverterContext(String packageName,
 Function<org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference,URI> urlSupplier,
 org.apache.maven.tools.plugin.javadoc.JavadocReference... unresolvableReferences)

Method Details

getModuleName

public Optional<String> getModuleName()

Specified by:

getModuleName in interface ConverterContext

getPackageName

public String getPackageName()

Specified by:

getPackageName in interface ConverterContext

getLocation

public String getLocation()

Specified by:

getLocation in interface ConverterContext

resolveReference

public org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference resolveReference(org.apache.maven.tools.plugin.javadoc.JavadocReference reference)

Specified by:

resolveReference in interface ConverterContext

getUrl

public URI getUrl(org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference reference)

Specified by:

getUrl in interface ConverterContext

isReferencedBy

public boolean isReferencedBy(org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference reference)

Specified by:

isReferencedBy in interface ConverterContext

getStaticFieldValue

public String getStaticFieldValue(org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference reference)

Specified by:

getStaticFieldValue in interface ConverterContext

getInternalJavadocSiteBaseUrl

public URI getInternalJavadocSiteBaseUrl()

Specified by:

getInternalJavadocSiteBaseUrl in interface ConverterContext

setAttribute

public <T> T setAttribute(String name,
 T value)

Specified by:

setAttribute in interface ConverterContext

getAttribute

public <T> T getAttribute(String name,
 Class<T> clazz,
 T defaultValue)

Specified by:

getAttribute in interface ConverterContext

canGetUrl

public boolean canGetUrl()

Specified by:

canGetUrl in interface ConverterContext