org.codehaus.mojo.servicedocgen.descriptor

Class ParameterDescriptor

java.lang.Object

org.codehaus.mojo.servicedocgen.descriptor.AbstractDescriptor

org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

All Implemented Interfaces:

Descriptor

public class ParameterDescriptor
extends AbstractDescriptor

Descriptor of a parameter of an operation.

Author:

hohwille

See Also:

OperationDescriptor.getParameters()

Field Summary

Fields inherited from interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP_METHOD_DELETE, HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_OPTIONS, HTTP_METHOD_PATCH, HTTP_METHOD_POST, HTTP_METHOD_PUT, LOCATION_BODY, LOCATION_COOKIE, LOCATION_FORM_DATA, LOCATION_HEADER, LOCATION_PATH, LOCATION_QUERY, SCHEME_HTTP, SCHEME_HTTPS, SCHEME_WS, SCHEME_WSS, STATUS_CODE_BAD_REQUEST, STATUS_CODE_CONFLICT, STATUS_CODE_FORBIDDEN, STATUS_CODE_INTERNAL_SERVER_ERROR, STATUS_CODE_NO_CONTENT, STATUS_CODE_SUCCESS, STATUS_CODE_UNAUTHORIZED

Constructor Summary

Constructors

Constructor and Description
ParameterDescriptor()

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue()
String	getDescription()
String	getExample()
JParameter	getJavaParameter()
String	getJavaScriptType()
String	getLocation()
String	getName()
boolean	isRequired()
void	setDefaultValue(String defaultValue)
void	setDescription(String description)
void	setExample(String example)
void	setJavaParameter(JParameter javaParameter)
void	setJavaScriptType(String javaScriptType)
void	setLocation(String location)
void	setName(String name)
void	setRequired(boolean required)

Methods inherited from class org.codehaus.mojo.servicedocgen.descriptor.AbstractDescriptor

notNull

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterDescriptor

public ParameterDescriptor()

Method Detail

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - is the name to set

getLocation

public String getLocation()

Returns:

the in

See Also:

Descriptor.LOCATION_BODY, Descriptor.LOCATION_PATH, Descriptor.LOCATION_HEADER, Descriptor.LOCATION_QUERY, Descriptor.LOCATION_FORM_DATA, Descriptor.LOCATION_COOKIE

setLocation

public void setLocation(String location)

Parameters:

location - is the location to set

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - is the description to set

getExample

public String getExample()

Returns:

the example

setExample

public void setExample(String example)

Parameters:

example - is the example to set

getDefaultValue

public String getDefaultValue()

Returns:

the defaultValue

setDefaultValue

public void setDefaultValue(String defaultValue)

Parameters:

defaultValue - is the defaultValue to set

isRequired

public boolean isRequired()

Returns:

the required

setRequired

public void setRequired(boolean required)

Parameters:

required - is the required to set

getJavaScriptType

public String getJavaScriptType()

Returns:

the javaScriptType

setJavaScriptType

public void setJavaScriptType(String javaScriptType)

Parameters:

javaScriptType - is the javaScriptType to set

getJavaParameter

public JParameter getJavaParameter()

Returns:

the javaParameter

setJavaParameter

public void setJavaParameter(JParameter javaParameter)

Parameters:

javaParameter - is the javaParameter to set