Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Apache CXF API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.cxf.jaxrs.model.wadl
Class JavaDocProvider

java.lang.Object
  extended by org.apache.cxf.jaxrs.model.wadl.JavaDocProvider
All Implemented Interfaces:
DocumentationProvider
public class JavaDocProvider
extends Object
implements DocumentationProvider

Field Summary
static double JAVA_VERSION
           
static double JAVA_VERSION_16
           
 
Constructor Summary
JavaDocProvider(Bus bus, String path)
           
JavaDocProvider(String path)
           
JavaDocProvider(URL javaDocUrl)
           
 
Method Summary
 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 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
Constructor Detail

JavaDocProvider

public JavaDocProvider(URL javaDocUrl)

JavaDocProvider

public JavaDocProvider(String path)
                throws Exception
Throws:
Exception

JavaDocProvider

public JavaDocProvider(Bus bus,
                       String path)
                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()

setJavaDocsBuiltByVersion

public void setJavaDocsBuiltByVersion(String version)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Apache CXF API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Apache CXF