C E F G H I L M O P S V W

C

ClassInfo - Class in com.j256.springrequestdoclet.collector

Information from the class being collected.

ClassInfo(String, String, String, String, String[]) - Constructor for class com.j256.springrequestdoclet.collector.ClassInfo

com.j256.springrequestdoclet - package com.j256.springrequestdoclet

Top level code used externally.

com.j256.springrequestdoclet.collector - package com.j256.springrequestdoclet.collector

Classes which investigate the classes and extract the documentation information.

com.j256.springrequestdoclet.writer - package com.j256.springrequestdoclet.writer

Writer(s) that output the documentation that was collected.

compareTo(ClassInfo) - Method in class com.j256.springrequestdoclet.collector.ClassInfo

compareTo(MethodInfo) - Method in class com.j256.springrequestdoclet.collector.MethodInfo

ContentsInfo - Class in com.j256.springrequestdoclet.collector

Method parameter information which shows how the parameter values are set.

E

EndPoint - Class in com.j256.springrequestdoclet.collector

Request end-point information that is mapped to a request path.

EndPoint(String, ClassInfo, MethodInfo) - Constructor for class com.j256.springrequestdoclet.collector.EndPoint

EndPointCollector - Class in com.j256.springrequestdoclet.collector

Collector that processed the class documentation and extracts and processes the information.

EndPointCollector() - Constructor for class com.j256.springrequestdoclet.collector.EndPointCollector

EndPointMapWriter - Interface in com.j256.springrequestdoclet.writer

Class which writes out our end-point documentation.

equals(Object) - Method in class com.j256.springrequestdoclet.collector.ClassInfo

F

FieldInfo - Class in com.j256.springrequestdoclet.collector

Information about an object fields that help us

FieldInfo(String, String, String) - Constructor for class com.j256.springrequestdoclet.collector.FieldInfo

fromPathVariable(String, String, String, boolean, String, String) - Static method in class com.j256.springrequestdoclet.collector.ParamInfo

fromRequestBody(String, String, String, List<FieldInfo>) - Static method in class com.j256.springrequestdoclet.collector.ContentsInfo

fromRequestHeader(String, String, String, boolean, String, String) - Static method in class com.j256.springrequestdoclet.collector.ParamInfo

fromRequestParam(String, String, String, boolean, String, String) - Static method in class com.j256.springrequestdoclet.collector.ParamInfo

fromResponse(String, String, List<FieldInfo>) - Static method in class com.j256.springrequestdoclet.collector.ContentsInfo

G

getClassInfo() - Method in class com.j256.springrequestdoclet.collector.EndPoint

getClassName() - Method in class com.j256.springrequestdoclet.collector.ClassInfo

getConsumes() - Method in class com.j256.springrequestdoclet.collector.MethodInfo

getDefaultValue() - Method in class com.j256.springrequestdoclet.collector.ParamInfo

NOTE: always null for path-variable.

getDescription() - Method in enum com.j256.springrequestdoclet.collector.ParamInfo.ParamRequestKind

getFieldInfos() - Method in class com.j256.springrequestdoclet.collector.ContentsInfo

getFieldName() - Method in class com.j256.springrequestdoclet.collector.FieldInfo

getHeaders() - Method in class com.j256.springrequestdoclet.collector.MethodInfo

getHttpMethods() - Method in class com.j256.springrequestdoclet.collector.MethodInfo

getJavaDoc() - Method in class com.j256.springrequestdoclet.collector.ClassInfo

getJavaDoc() - Method in class com.j256.springrequestdoclet.collector.ContentsInfo

getJavaDoc() - Method in class com.j256.springrequestdoclet.collector.FieldInfo

getJavaDoc() - Method in class com.j256.springrequestdoclet.collector.MethodInfo

getJavaDoc() - Method in class com.j256.springrequestdoclet.collector.ParamInfo

getJavaDocFirstSentence() - Method in class com.j256.springrequestdoclet.collector.ClassInfo

getJavaDocFirstSentence() - Method in class com.j256.springrequestdoclet.collector.MethodInfo

getJavaMethodName() - Method in class com.j256.springrequestdoclet.collector.MethodInfo

getJavaParamName() - Method in class com.j256.springrequestdoclet.collector.ContentsInfo

getJavaParamName() - Method in class com.j256.springrequestdoclet.collector.ParamInfo

getJavaTypeName() - Method in class com.j256.springrequestdoclet.collector.ContentsInfo

getJavaTypeName() - Method in class com.j256.springrequestdoclet.collector.ParamInfo

getMethodInfo() - Method in class com.j256.springrequestdoclet.collector.EndPoint

getParamInfos() - Method in class com.j256.springrequestdoclet.collector.MethodInfo

getParams() - Method in class com.j256.springrequestdoclet.collector.MethodInfo

getPath() - Method in class com.j256.springrequestdoclet.collector.EndPoint

getPathInfoMap() - Method in class com.j256.springrequestdoclet.collector.EndPointCollector

getPaths() - Method in class com.j256.springrequestdoclet.collector.ClassInfo

getPaths() - Method in class com.j256.springrequestdoclet.collector.MethodInfo

getProduces() - Method in class com.j256.springrequestdoclet.collector.MethodInfo

getRequestInfo() - Method in class com.j256.springrequestdoclet.collector.MethodInfo

getRequestKind() - Method in class com.j256.springrequestdoclet.collector.ParamInfo

getRequestName() - Method in class com.j256.springrequestdoclet.collector.ParamInfo

One of this, path-variable, or header-name will not be null.

getResponseInfo() - Method in class com.j256.springrequestdoclet.collector.MethodInfo

getTypeName() - Method in class com.j256.springrequestdoclet.collector.ClassInfo

getTypeName() - Method in class com.j256.springrequestdoclet.collector.FieldInfo

getUniqueName() - Method in class com.j256.springrequestdoclet.collector.MethodInfo

H

hashCode() - Method in class com.j256.springrequestdoclet.collector.ClassInfo

HtmlPathMapWriter - Class in com.j256.springrequestdoclet.writer

Writes out a HTML file describing the path information.

HtmlPathMapWriter() - Constructor for class com.j256.springrequestdoclet.writer.HtmlPathMapWriter

I

isRequired() - Method in class com.j256.springrequestdoclet.collector.ParamInfo

NOTE: always true for path-variable.

L

languageVersion() - Static method in class com.j256.springrequestdoclet.SpringRequestDoclet

This method may be necessary to expose show generic arguments in the class information.

M

MethodInfo - Class in com.j256.springrequestdoclet.collector

Method information which refines the request path and adds other narrowing fields.

MethodInfo(String, String, String, String, String[], String[], String[], String[], String[], String[], List<ParamInfo>, ContentsInfo, ContentsInfo) - Constructor for class com.j256.springrequestdoclet.collector.MethodInfo

O

optionLength(String) - Static method in class com.j256.springrequestdoclet.SpringRequestDoclet

This method is necessary otherwise syntax errors because of invalid options is generated.

P

ParamInfo - Class in com.j256.springrequestdoclet.collector

Method parameter information which shows how the parameter values are set.

ParamInfo.ParamRequestKind - Enum in com.j256.springrequestdoclet.collector

Type of the parameter.

processClass(ClassDoc) - Method in class com.j256.springrequestdoclet.collector.EndPointCollector

S

SpringRequestDoclet - Class in com.j256.springrequestdoclet

Spring request doclet main class.

SpringRequestDoclet() - Constructor for class com.j256.springrequestdoclet.SpringRequestDoclet

start(RootDoc) - Static method in class com.j256.springrequestdoclet.SpringRequestDoclet

Actually do the processing of the variable class information so we can general the documentation output.

V

validOptions(String[][], DocErrorReporter) - Static method in class com.j256.springrequestdoclet.SpringRequestDoclet

This method is necessary otherwise syntax errors are generated because of invalid options is generated.

valueOf(String) - Static method in enum com.j256.springrequestdoclet.collector.ParamInfo.ParamRequestKind

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.j256.springrequestdoclet.collector.ParamInfo.ParamRequestKind

Returns an array containing the constants of this enum type, in the order they are declared.

W

write(Map<String, List<EndPoint>>, File) - Method in interface com.j256.springrequestdoclet.writer.EndPointMapWriter

Write our end-point information out.

write(Map<String, List<EndPoint>>, File) - Method in class com.j256.springrequestdoclet.writer.HtmlPathMapWriter

C E F G H I L M O P S V W