net.ozwolf.raml.annotations

Annotation Type RamlParameter

@Retention(value=RUNTIME)
public @interface RamlParameter

RAML Parameter Annotation

Annotation to describe a parameter.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of the parameter.
String	type The type of parameter.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	allowedValues The list of allowed values as a string list.
Class<? extends Enum>	allowedValuesEnum The enum the allowed values for the parameter are derived from.
String	defaultValue The default for the parameter if not supplied.
String	description The description of the parameter
String	displayName The display name of the parameter.
String	example The example of the parameter.
long	maximum The maximum value the parameter is allowed to have.
long	minimum The minimum value the parameter is allowed to have.
boolean	multiple Flag if the parameter accepts multiple values.
String	pattern The regular expression pattern the parameter must adhere to.
boolean	required Flag if the parameter is required or not.

Element Detail

name

public abstract String name

The name of the parameter.

Returns:

the parameter name

type

public abstract String type

The type of parameter.

If describing an array parameter, define the item type here.

Must align with the Allowable Built-In Types

Returns:

the parameter type

displayName

public abstract String displayName

The display name of the parameter.

Returns:

the parameter display name

Default:

""

description

public abstract String description

The description of the parameter

Returns:

the parameter description

Default:

""

required

public abstract boolean required

Flag if the parameter is required or not.

Returns:

the required flag

Default:

true

multiple

public abstract boolean multiple

Flag if the parameter accepts multiple values.

Returns:

the multiple flag

Default:

false

allowedValues

public abstract String[] allowedValues

The list of allowed values as a string list.

If the allowedValuesEnum() property is defined, this is ignored.

Returns:

the list of allowed values

Default:

{}

allowedValuesEnum

public abstract Class<? extends Enum> allowedValuesEnum

The enum the allowed values for the parameter are derived from.

Returns:

the allowed values enum class

Default:

net.ozwolf.raml.annotations.RamlParameter.NoEnum.class

example

public abstract String example

The example of the parameter.

Returns:

the parameter example

Default:

""

pattern

public abstract String pattern

The regular expression pattern the parameter must adhere to.

Only suitable for string-based parameters.

Returns:

the regex pattern

Default:

""

defaultValue

public abstract String defaultValue

The default for the parameter if not supplied.

Returns:

the parameter default

Default:

""

minimum

public abstract long minimum

The minimum value the parameter is allowed to have.

Only suitable for numeric-based parameters.

Returns:

the parameter minimum value

Default:

-9223372036854775808L

maximum

public abstract long maximum

The maximum value the parameter is allowed to have.

Only suitable for numeric-based parameters.

Returns:

the parameter maximum value

Default:

-9223372036854775808L