com.j256.springrequestdoclet.collector

Class ParamInfo

java.lang.Object

com.j256.springrequestdoclet.collector.ParamInfo

public class ParamInfo
extends Object

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

Author:

graywatson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParamInfo.ParamRequestKind Type of the parameter.

Method Summary

Methods

Modifier and Type	Method and Description
static ParamInfo	fromPathVariable(String javaParamName, String javaTypeName, String pathVariableName, boolean required, String defaultValue, String javaDoc)
static ParamInfo	fromRequestHeader(String javaParamName, String javaTypeName, String requestHeaderName, boolean required, String defaultValue, String javaDoc)
static ParamInfo	fromRequestParam(String javaParamName, String javaTypeName, String queryParamName, boolean required, String defaultValue, String javaDoc)
String	getDefaultValue() NOTE: always null for path-variable.
String	getJavaDoc()
String	getJavaParamName()
String	getJavaTypeName()
ParamInfo.ParamRequestKind	getRequestKind()
String	getRequestName() One of this, path-variable, or header-name will not be null.
boolean	isRequired() NOTE: always true for path-variable.

Methods inherited from class java.lang.Object

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

Method Detail

fromRequestParam

public static ParamInfo fromRequestParam(String javaParamName,
                         String javaTypeName,
                         String queryParamName,
                         boolean required,
                         String defaultValue,
                         String javaDoc)

fromPathVariable

public static ParamInfo fromPathVariable(String javaParamName,
                         String javaTypeName,
                         String pathVariableName,
                         boolean required,
                         String defaultValue,
                         String javaDoc)

fromRequestHeader

public static ParamInfo fromRequestHeader(String javaParamName,
                          String javaTypeName,
                          String requestHeaderName,
                          boolean required,
                          String defaultValue,
                          String javaDoc)

getJavaParamName

public String getJavaParamName()

getJavaTypeName

public String getJavaTypeName()

getRequestKind

public ParamInfo.ParamRequestKind getRequestKind()

getRequestName

public String getRequestName()

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

isRequired

public boolean isRequired()

NOTE: always true for path-variable.

getDefaultValue

public String getDefaultValue()

NOTE: always null for path-variable.

getJavaDoc

public String getJavaDoc()