A C D E F G H I J L M N O P Q R S T W

A

AbstractCollector - Class in org.calrissian.restdoclet.collector

AbstractCollector() - Constructor for class org.calrissian.restdoclet.collector.AbstractCollector

addApi(String, String) - Method in class org.calrissian.restdoclet.writer.swagger.model.ResourceListing

ANNOTATION_PACKAGE - Static variable in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

AnnotationUtils - Class in org.calrissian.restdoclet.util

AnnotationUtils() - Constructor for class org.calrissian.restdoclet.util.AnnotationUtils

Api - Class in org.calrissian.restdoclet.writer.swagger.model

Api(String, String, Collection<Operation>) - Constructor for class org.calrissian.restdoclet.writer.swagger.model.Api

ApiListing - Class in org.calrissian.restdoclet.writer.swagger.model

ApiListing(String, String, String, String, Collection<Api>) - Constructor for class org.calrissian.restdoclet.writer.swagger.model.ApiListing

C

ClassDescriptor - Class in org.calrissian.restdoclet.model

ClassDescriptor(String, String, Collection<Endpoint>, String) - Constructor for class org.calrissian.restdoclet.model.ClassDescriptor

close(Closeable...) - Static method in class org.calrissian.restdoclet.util.CommonUtils

Collector - Interface in org.calrissian.restdoclet.collector

CommonUtils - Class in org.calrissian.restdoclet.util

Simple utilities to reduce the number of dependencies needed for the project

CommonUtils() - Constructor for class org.calrissian.restdoclet.util.CommonUtils

Configuration - Class in org.calrissian.restdoclet

Configuration(String[][]) - Constructor for class org.calrissian.restdoclet.Configuration

CONSUMES_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

CONTEXT_TAG - Static variable in class org.calrissian.restdoclet.util.TagUtils

CONTROLLER_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.spring.SpringCollector

copy(InputStream, OutputStream) - Static method in class org.calrissian.restdoclet.util.CommonUtils

D

DELETE_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

E

Endpoint - Class in org.calrissian.restdoclet.model

Endpoint(String, String, Collection<QueryParam>, Collection<PathVar>, RequestBody, Collection<String>, Collection<String>, String, String, Type) - Constructor for class org.calrissian.restdoclet.model.Endpoint

EndpointMapping - Class in org.calrissian.restdoclet.collector

EndpointMapping(Collection<String>, Collection<String>, Collection<String>, Collection<String>) - Constructor for class org.calrissian.restdoclet.collector.EndpointMapping

F

findParamText(Tag[], String) - Static method in class org.calrissian.restdoclet.util.TagUtils

firstNonEmpty(Collection<T>...) - Static method in class org.calrissian.restdoclet.util.CommonUtils

firstSentence(Doc) - Static method in class org.calrissian.restdoclet.util.TagUtils

fixPath(String) - Static method in class org.calrissian.restdoclet.util.CommonUtils

G

generatePathVars(MethodDoc) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

generatePathVars(MethodDoc) - Method in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

generatePathVars(MethodDoc) - Method in class org.calrissian.restdoclet.collector.spring.SpringCollector

generateQueryParams(MethodDoc) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

generateQueryParams(MethodDoc) - Method in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

generateQueryParams(MethodDoc) - Method in class org.calrissian.restdoclet.collector.spring.SpringCollector

generateRequestBody(MethodDoc) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

generateRequestBody(MethodDoc) - Method in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

generateRequestBody(MethodDoc) - Method in class org.calrissian.restdoclet.collector.spring.SpringCollector

GET_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

getAllEndpoints(String, ClassDoc, EndpointMapping) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

Retrieves all the end point provided in the specified class doc.

getAllowableValues() - Method in class org.calrissian.restdoclet.writer.swagger.model.Parameter

getAnnotationName(AnnotationDesc) - Static method in class org.calrissian.restdoclet.util.AnnotationUtils

getApis() - Method in class org.calrissian.restdoclet.writer.swagger.model.ApiListing

getApis() - Method in class org.calrissian.restdoclet.writer.swagger.model.ResourceListing

getApiVersion() - Method in class org.calrissian.restdoclet.Configuration

getApiVersion() - Method in class org.calrissian.restdoclet.writer.swagger.model.ApiListing

getApiVersion() - Method in class org.calrissian.restdoclet.writer.swagger.model.ResourceListing

getBasePath() - Method in class org.calrissian.restdoclet.writer.swagger.model.ApiListing

getClassDescription(ClassDoc) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

Will get the description for the class.

getClassDescriptor(ClassDoc) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

Will generate a single class descriptor and all the endpoints for that class.

getClassName(ClassDoc) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

Will get the display name for the class.

getConsumes() - Method in class org.calrissian.restdoclet.collector.EndpointMapping

getConsumes() - Method in class org.calrissian.restdoclet.model.Endpoint

getConsumes() - Method in class org.calrissian.restdoclet.writer.swagger.model.Operation

getContextPath(ClassDoc) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

Will get the initial context path to use for all rest endpoint.

getContextPath() - Method in class org.calrissian.restdoclet.model.ClassDescriptor

getDescription() - Method in class org.calrissian.restdoclet.model.ClassDescriptor

getDescription() - Method in class org.calrissian.restdoclet.model.Endpoint

getDescription() - Method in class org.calrissian.restdoclet.model.PathVar

getDescription() - Method in class org.calrissian.restdoclet.model.QueryParam

getDescription() - Method in class org.calrissian.restdoclet.model.RequestBody

getDescription() - Method in class org.calrissian.restdoclet.writer.swagger.model.Api

getDescription() - Method in class org.calrissian.restdoclet.writer.swagger.model.Parameter

getDescriptors(RootDoc) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

Will generate and aggregate all the rest endpoint class descriptors.

getDescriptors(RootDoc) - Method in interface org.calrissian.restdoclet.collector.Collector

getDocumentTitle() - Method in class org.calrissian.restdoclet.Configuration

getElementValue(AnnotationDesc, String) - Static method in class org.calrissian.restdoclet.util.AnnotationUtils

getEndpoint(String, EndpointMapping, MethodDoc) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

Retrieves the endpoint for a single method.

getEndpointMapping(ProgramElementDoc) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

getEndpointMapping(ProgramElementDoc) - Method in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

getEndpointMapping(ProgramElementDoc) - Method in class org.calrissian.restdoclet.collector.spring.SpringCollector

getEndpoints() - Method in class org.calrissian.restdoclet.model.ClassDescriptor

getFormat() - Method in class org.calrissian.restdoclet.writer.swagger.model.Parameter

getHttpMethod() - Method in class org.calrissian.restdoclet.model.Endpoint

getHttpMethods() - Method in class org.calrissian.restdoclet.collector.EndpointMapping

getInfo() - Method in class org.calrissian.restdoclet.writer.swagger.model.ResourceListing

getMethod() - Method in class org.calrissian.restdoclet.writer.swagger.model.Operation

getName() - Method in class org.calrissian.restdoclet.model.ClassDescriptor

getName() - Method in class org.calrissian.restdoclet.model.PathVar

getName() - Method in class org.calrissian.restdoclet.model.QueryParam

getName() - Method in class org.calrissian.restdoclet.model.RequestBody

getName() - Method in class org.calrissian.restdoclet.writer.swagger.model.Parameter

getNickname() - Method in class org.calrissian.restdoclet.writer.swagger.model.Operation

getNotes() - Method in class org.calrissian.restdoclet.writer.swagger.model.Operation

getOperations() - Method in class org.calrissian.restdoclet.writer.swagger.model.Api

getOptionLength(String) - Static method in class org.calrissian.restdoclet.Configuration

getOutputFormat() - Method in class org.calrissian.restdoclet.Configuration

getParameters() - Method in class org.calrissian.restdoclet.writer.swagger.model.Operation

getParamType() - Method in class org.calrissian.restdoclet.writer.swagger.model.Parameter

getPath() - Method in class org.calrissian.restdoclet.Configuration

getPath() - Method in class org.calrissian.restdoclet.model.Endpoint

getPath() - Method in class org.calrissian.restdoclet.writer.swagger.model.Api

getPaths() - Method in class org.calrissian.restdoclet.collector.EndpointMapping

getPathVars() - Method in class org.calrissian.restdoclet.model.Endpoint

getProduces() - Method in class org.calrissian.restdoclet.collector.EndpointMapping

getProduces() - Method in class org.calrissian.restdoclet.model.Endpoint

getProduces() - Method in class org.calrissian.restdoclet.writer.swagger.model.Operation

getQueryParams() - Method in class org.calrissian.restdoclet.model.Endpoint

getRequestBody() - Method in class org.calrissian.restdoclet.model.Endpoint

getResourcePath() - Method in class org.calrissian.restdoclet.writer.swagger.model.ApiListing

getShortDescription() - Method in class org.calrissian.restdoclet.model.Endpoint

getStyleSheet() - Method in class org.calrissian.restdoclet.Configuration

getSummary() - Method in class org.calrissian.restdoclet.writer.swagger.model.Operation

getSwaggerVersion() - Method in class org.calrissian.restdoclet.writer.swagger.model.ApiListing

getSwaggerVersion() - Method in class org.calrissian.restdoclet.writer.swagger.model.ResourceListing

getType() - Method in class org.calrissian.restdoclet.model.Endpoint

getType() - Method in class org.calrissian.restdoclet.model.PathVar

getType() - Method in class org.calrissian.restdoclet.model.QueryParam

getType() - Method in class org.calrissian.restdoclet.model.RequestBody

getType() - Method in class org.calrissian.restdoclet.writer.swagger.model.Operation

getType() - Method in class org.calrissian.restdoclet.writer.swagger.model.Parameter

H

HEAD_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

I

IGNORE_TAG - Static variable in class org.calrissian.restdoclet.util.TagUtils

isAllowMultiple() - Method in class org.calrissian.restdoclet.writer.swagger.model.Parameter

isCallable() - Method in class org.calrissian.restdoclet.Configuration

isdefaultStyleSheet() - Method in class org.calrissian.restdoclet.Configuration

isEmpty(T[]) - Static method in class org.calrissian.restdoclet.util.CommonUtils

isEmpty(Collection<T>) - Static method in class org.calrissian.restdoclet.util.CommonUtils

isEmpty(String) - Static method in class org.calrissian.restdoclet.util.CommonUtils

isRequired() - Method in class org.calrissian.restdoclet.model.QueryParam

isRequired() - Method in class org.calrissian.restdoclet.writer.swagger.model.Parameter

J

JaxRSCollector - Class in org.calrissian.restdoclet.collector.jaxrs

JaxRSCollector() - Constructor for class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

L

languageVersion() - Static method in class org.calrissian.restdoclet.RestDoclet

NOTE: Without this method present and returning LanguageVersion.JAVA_1_5, Javadoc will not process generics because it assumes LanguageVersion.JAVA_1_1

M

MAPPING_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.spring.SpringCollector

N

NAME_TAG - Static variable in class org.calrissian.restdoclet.util.TagUtils

O

Operation - Class in org.calrissian.restdoclet.writer.swagger.model

Operation(String, String, String, String, String, Collection<String>, Collection<String>, Collection<Parameter>) - Constructor for class org.calrissian.restdoclet.writer.swagger.model.Operation

optionLength(String) - Static method in class org.calrissian.restdoclet.RestDoclet

Required to validate command line options.

org.calrissian.restdoclet - package org.calrissian.restdoclet

org.calrissian.restdoclet.collector - package org.calrissian.restdoclet.collector

org.calrissian.restdoclet.collector.jaxrs - package org.calrissian.restdoclet.collector.jaxrs

org.calrissian.restdoclet.collector.spring - package org.calrissian.restdoclet.collector.spring

org.calrissian.restdoclet.model - package org.calrissian.restdoclet.model

org.calrissian.restdoclet.util - package org.calrissian.restdoclet.util

org.calrissian.restdoclet.writer - package org.calrissian.restdoclet.writer

org.calrissian.restdoclet.writer.simple - package org.calrissian.restdoclet.writer.simple

org.calrissian.restdoclet.writer.swagger - package org.calrissian.restdoclet.writer.swagger

org.calrissian.restdoclet.writer.swagger.model - package org.calrissian.restdoclet.writer.swagger.model

OUTPUT_OPTION_NAME - Static variable in class org.calrissian.restdoclet.writer.simple.SimpleHtmlWriter

OUTPUT_OPTION_NAME - Static variable in class org.calrissian.restdoclet.writer.swagger.SwaggerWriter

P

PARAM_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

PARAM_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.spring.SpringCollector

Parameter - Class in org.calrissian.restdoclet.writer.swagger.model

Parameter(String, String, String, String, String, boolean, boolean, Collection<String>) - Constructor for class org.calrissian.restdoclet.writer.swagger.model.Parameter

PATH_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

PathVar - Class in org.calrissian.restdoclet.model

PathVar(String, String, Type) - Constructor for class org.calrissian.restdoclet.model.PathVar

PATHVAR_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

PATHVAR_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.spring.SpringCollector

PATHVAR_TAG - Static variable in class org.calrissian.restdoclet.util.TagUtils

POST_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

PRODUCES_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

PUT_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

Q

QueryParam - Class in org.calrissian.restdoclet.model

QueryParam(String, boolean, String, Type) - Constructor for class org.calrissian.restdoclet.model.QueryParam

QUERYPARAM_TAG - Static variable in class org.calrissian.restdoclet.util.TagUtils

R

RequestBody - Class in org.calrissian.restdoclet.model

RequestBody(String, String, Type) - Constructor for class org.calrissian.restdoclet.model.RequestBody

REQUESTBODY_ANNOTATION - Static variable in class org.calrissian.restdoclet.collector.spring.SpringCollector

REQUESTBODY_TAG - Static variable in class org.calrissian.restdoclet.util.TagUtils

resolveConsumesInfo(EndpointMapping, EndpointMapping) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

Will use the method's mapped information if it is not empty, otherwise it will use the class mapping information to retrieve all the consumeable information.

resolveHttpMethods(EndpointMapping, EndpointMapping) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

Will use the method's mapped information if it is not empty, otherwise it will use the class mapping information to retrieve all the https methods.

resolveHttpMethods(EndpointMapping, EndpointMapping) - Method in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

resolveHttpMethods(EndpointMapping, EndpointMapping) - Method in class org.calrissian.restdoclet.collector.spring.SpringCollector

resolvePaths(String, EndpointMapping, EndpointMapping) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

Will generate all the paths specified in the class and method mappings.

resolvesProducesInfo(EndpointMapping, EndpointMapping) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

Will use the method's mapped information if it is not empty, otherwise it will use the class mapping information to retrieve all the produceable information.

ResourceListing - Class in org.calrissian.restdoclet.writer.swagger.model

ResourceListing(String, String, String) - Constructor for class org.calrissian.restdoclet.writer.swagger.model.ResourceListing

RestDoclet - Class in org.calrissian.restdoclet

RestDoclet() - Constructor for class org.calrissian.restdoclet.RestDoclet

S

shouldIgnoreClass(ClassDoc) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

shouldIgnoreClass(ClassDoc) - Method in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

shouldIgnoreClass(ClassDoc) - Method in class org.calrissian.restdoclet.collector.spring.SpringCollector

shouldIgnoreMethod(MethodDoc) - Method in class org.calrissian.restdoclet.collector.AbstractCollector

shouldIgnoreMethod(MethodDoc) - Method in class org.calrissian.restdoclet.collector.jaxrs.JaxRSCollector

shouldIgnoreMethod(MethodDoc) - Method in class org.calrissian.restdoclet.collector.spring.SpringCollector

SimpleHtmlWriter - Class in org.calrissian.restdoclet.writer.simple

SimpleHtmlWriter() - Constructor for class org.calrissian.restdoclet.writer.simple.SimpleHtmlWriter

SpringCollector - Class in org.calrissian.restdoclet.collector.spring

SpringCollector() - Constructor for class org.calrissian.restdoclet.collector.spring.SpringCollector

start(RootDoc) - Static method in class org.calrissian.restdoclet.RestDoclet

Generate documentation here.

SwaggerWriter - Class in org.calrissian.restdoclet.writer.swagger

SwaggerWriter() - Constructor for class org.calrissian.restdoclet.writer.swagger.SwaggerWriter

T

TagUtils - Class in org.calrissian.restdoclet.util

TagUtils() - Constructor for class org.calrissian.restdoclet.util.TagUtils

toString() - Method in class org.calrissian.restdoclet.model.ClassDescriptor

toString() - Method in class org.calrissian.restdoclet.model.Endpoint

toString() - Method in class org.calrissian.restdoclet.model.PathVar

toString() - Method in class org.calrissian.restdoclet.model.QueryParam

toString() - Method in class org.calrissian.restdoclet.model.RequestBody

W

write(Collection<ClassDescriptor>, Configuration) - Method in class org.calrissian.restdoclet.writer.simple.SimpleHtmlWriter

write(Collection<ClassDescriptor>, Configuration) - Method in class org.calrissian.restdoclet.writer.swagger.SwaggerWriter

write(Collection<ClassDescriptor>, Configuration) - Method in interface org.calrissian.restdoclet.writer.Writer

Writer - Interface in org.calrissian.restdoclet.writer

A C D E F G H I J L M N O P Q R S T W