org.jooby.apitool.raml

Class RamlParameter

java.lang.Object

org.jooby.apitool.raml.RamlParameter

public class RamlParameter
extends Object

RAML parameter.

Since:

1.2.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
RamlParameter(String name) RAML parameter.

Method Summary

Modifier and Type	Method and Description
Object	getDefault() Default value.
String	getDescription() RAML description.
List<String>	getEnum() Enum values.
String	getName() Parameter name.
RamlType	getType() RAML type.
Boolean	isRequired() True for required parameter.
void	setDefault(Object defaultValue) Set default value.
void	setDescription(String description) Set description.
void	setEnum(List<String> enums) Set enum values.
void	setName(String name) Set parameter name.
void	setRequired(Boolean required) Set required parameter.
void	setType(RamlType type) Set RAML type.

Methods inherited from class java.lang.Object

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

Constructor Detail

RamlParameter

public RamlParameter(String name)

RAML parameter.

Parameters:

name - Parameter name.

Method Detail

getName

public String getName()

Parameter name.

Returns:

Parameter name.

setName

public void setName(String name)

Set parameter name.

Parameters:

name - Parameter name.

getType

public RamlType getType()

RAML type.

Returns:

RAML type.

setType

public void setType(RamlType type)

Set RAML type.

Parameters:

type - RAML type.

isRequired

public Boolean isRequired()

True for required parameter.

Returns:

True for required parameter.

setRequired

public void setRequired(Boolean required)

Set required parameter.

Parameters:

required - Required parameter.

getDescription

public String getDescription()

RAML description.

Returns:

Description.

setDescription

public void setDescription(String description)

Set description.

Parameters:

description - RAML description.

getDefault

public Object getDefault()

Default value.

Returns:

Default value.

setDefault

public void setDefault(Object defaultValue)

Set default value.

Parameters:

defaultValue - Default value.

getEnum

public List<String> getEnum()

Enum values.

Returns:

Enum values.

setEnum

public void setEnum(List<String> enums)

Set enum values.

Parameters:

enums - Enum values.