Package com.peterphi.std.guice.web.rest.service.servicedescription.freemarker

Class RestServiceResourceInfo

java.lang.Object

com.peterphi.std.guice.web.rest.service.servicedescription.freemarker.RestServiceResourceInfo

All Implemented Interfaces:

Comparable<RestServiceResourceInfo>

public class RestServiceResourceInfo
extends Object
implements Comparable<RestServiceResourceInfo>

Helper type to provide

Constructor Summary

Constructors

Constructor	Description
RestServiceResourceInfo(RestServiceInfo service, Method method)

Method Summary

Modifier and Type	Method	Description
int	compareTo(RestServiceResourceInfo that)
String	getConsumes()
String	getCurlTemplate(String url, ExampleGenerator exampleGenerator)
String	getDescription()
String	getHttpMethod()
String	getLocalPath()
String	getMethodString()
List<RestServiceResourceParamInfo>	getParameters()
String	getPath()
String	getProduces()
RestServiceResourceParamInfo	getRequestEntity()
Class<?>	getReturnType()
List<String>	getSeeAlsoURLs()
boolean	isDeprecated()
boolean	isPlainGet()
boolean	isRequestXML()
static boolean	isResource(Method method)
boolean	isResponseXML()

Methods inherited from class java.lang.Object

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

Constructor Details

RestServiceResourceInfo

public RestServiceResourceInfo(RestServiceInfo service,
 Method method)

Method Details

isResource

public static boolean isResource(Method method)

isDeprecated

public boolean isDeprecated()

getHttpMethod

public String getHttpMethod()

isPlainGet

public boolean isPlainGet()

isRequestXML

public boolean isRequestXML()

isResponseXML

public boolean isResponseXML()

getMethodString

public String getMethodString()

getParameters

public List<RestServiceResourceParamInfo> getParameters()

getRequestEntity

public RestServiceResourceParamInfo getRequestEntity()

compareTo

public int compareTo(RestServiceResourceInfo that)

Specified by:

compareTo in interface Comparable<RestServiceResourceInfo>

getPath

public String getPath()

getLocalPath

public String getLocalPath()

getReturnType

public Class<?> getReturnType()

getConsumes

public String getConsumes()

getProduces

public String getProduces()

getDescription

public String getDescription()

getSeeAlsoURLs

public List<String> getSeeAlsoURLs()

getCurlTemplate

public String getCurlTemplate(String url,
 ExampleGenerator exampleGenerator)
                       throws Exception

Throws:

Exception