Package org.apache.cxf.jaxrs.model.doc

Class JavaDocProvider

java.lang.Object

org.apache.cxf.jaxrs.model.doc.JavaDocProvider

All Implemented Interfaces:

DocumentationProvider

public class JavaDocProvider
extends Object
implements DocumentationProvider

Field Summary

Fields

Modifier and Type	Field	Description
static double	JAVA_VERSION
static double	JAVA_VERSION_16
static double	JAVA_VERSION_17
static double	JAVA_VERSION_18

Constructor Summary

Constructors

Constructor	Description
JavaDocProvider()
JavaDocProvider(String path)
JavaDocProvider(String... paths)
JavaDocProvider(URL... javaDocUrls)
JavaDocProvider(Bus bus, String... paths)

Method Summary

Modifier and Type	Method	Description
String	getClassDoc(ClassResourceInfo cri)
protected String	getClassInfoTag()
protected String	getCodeTag()
String	getMethodDoc(OperationResourceInfo ori)
String	getMethodParameterDoc(OperationResourceInfo ori, int paramIndex)
String	getMethodResponseDoc(OperationResourceInfo ori)
protected String	getOperationMarkerClose()
protected String	getOperationMarkerOpen()
protected String	getOperationParamSeparator()
protected String	getOperInfoTag()
protected String	getOperLink()
protected String	getResponseMarker()
void	setJavaDocsBuiltByVersion(String version)

Methods inherited from class java.lang.Object

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

Field Detail

JAVA_VERSION

public static final double JAVA_VERSION

JAVA_VERSION_16

public static final double JAVA_VERSION_16

See Also:

Constant Field Values

JAVA_VERSION_17

public static final double JAVA_VERSION_17

See Also:

Constant Field Values

JAVA_VERSION_18

public static final double JAVA_VERSION_18

See Also:

Constant Field Values

Constructor Detail

JavaDocProvider

public JavaDocProvider()

JavaDocProvider

public JavaDocProvider(URL... javaDocUrls)

JavaDocProvider

public JavaDocProvider(String path)
                throws Exception

Throws:

Exception

JavaDocProvider

public JavaDocProvider(String... paths)
                throws Exception

Throws:

Exception

JavaDocProvider

public JavaDocProvider(Bus bus,
                       String... paths)
                throws Exception

Throws:

Exception

Method Detail

getClassDoc

public String getClassDoc(ClassResourceInfo cri)

Specified by:

getClassDoc in interface DocumentationProvider

getMethodDoc

public String getMethodDoc(OperationResourceInfo ori)

Specified by:

getMethodDoc in interface DocumentationProvider

getMethodResponseDoc

public String getMethodResponseDoc(OperationResourceInfo ori)

Specified by:

getMethodResponseDoc in interface DocumentationProvider

getMethodParameterDoc

public String getMethodParameterDoc(OperationResourceInfo ori,
                                    int paramIndex)

Specified by:

getMethodParameterDoc in interface DocumentationProvider

getClassInfoTag

protected String getClassInfoTag()

getOperInfoTag

protected String getOperInfoTag()

getOperLink

protected String getOperLink()

getResponseMarker

protected String getResponseMarker()

getCodeTag

protected String getCodeTag()

getOperationMarkerOpen

protected String getOperationMarkerOpen()

getOperationMarkerClose

protected String getOperationMarkerClose()

getOperationParamSeparator

protected String getOperationParamSeparator()

setJavaDocsBuiltByVersion

public void setJavaDocsBuiltByVersion(String version)