org.jooby.apitool.raml

Class RamlType

java.lang.Object

org.jooby.apitool.raml.RamlType

public class RamlType
extends Object

RAML type which must be either Raml.define(Type) or Raml.define(Type). Basic types are available as static field instances: NUMBER, STRING, etc..

Since:

1.2.0

Author:

edgar

Field Summary

Fields

Modifier and Type	Field and Description
static RamlType	BOOLEAN Boolean.
static RamlType	DATE_TIME DateTime.
static RamlType	FILE File.
static RamlType	INTEGER Integer.
static RamlType	NUMBER Number.
static RamlType	STRING String.

Constructor Summary

Constructors

Constructor and Description
RamlType(String type) Creates a new RAML type.
RamlType(String type, String name) Creates a new RAML type.

Method Summary

Modifier and Type	Method and Description
Object	getExample() Example type.
Integer	getMaxLength() Get max length.
Integer	getMinLength() Get min length.
String	getPattern() Type Pattern.
Map<String,Object>	getProperties() Object properties.
RamlTypeRef	getRef() RAML type reference.
String	getType() One of string, number, object, etc.
boolean	isObject() True if this type is an object.
RamlType	newProperty(String name, String type, boolean required, String... values) Defines a new property.
void	setExample(Object example) Set example type.
void	setMaxLength(Integer maxLength) Set max length.
void	setMinLength(Integer minLength) Set min length.
void	setPattern(String pattern) Set type pattern.
RamlType	toArray() Build/make an array.
static RamlType	valueOf(String name) Get a RAML type from string.

Methods inherited from class java.lang.Object

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

Field Detail

NUMBER

public static final RamlType NUMBER

Number.

INTEGER

public static final RamlType INTEGER

Integer.

BOOLEAN

public static final RamlType BOOLEAN

Boolean.

STRING

public static final RamlType STRING

String.

FILE

public static final RamlType FILE

File.

DATE_TIME

public static final RamlType DATE_TIME

DateTime.

Constructor Detail

RamlType

public RamlType(String type)

Creates a new RAML type.

Parameters:

type - One of number, string, object, etc.

RamlType

public RamlType(String type,
                String name)

Creates a new RAML type.

Parameters:

type - One of number, string, object, etc.

name - Type name: Pet, Person, etc.

Method Detail

newProperty

public RamlType newProperty(String name,
                            String type,
                            boolean required,
                            String... values)

Defines a new property.

Parameters:

name - Property name.

type - Property type.

required - True for required.

values - Enum values.

Returns:

This type.

getRef

public RamlTypeRef getRef()

RAML type reference.

Returns:

RAML type reference.

getType

public String getType()

One of string, number, object, etc.

Returns:

One of string, number, object, etc.

getPattern

public String getPattern()

Type Pattern.

Returns:

Type Pattern.

setPattern

public void setPattern(String pattern)

Set type pattern.

Parameters:

pattern - Type Pattern.

getMinLength

public Integer getMinLength()

Get min length.

Returns:

Min length.

setMinLength

public void setMinLength(Integer minLength)

Set min length.

Parameters:

minLength - Min length.

getMaxLength

public Integer getMaxLength()

Get max length.

Returns:

Max length.

setMaxLength

public void setMaxLength(Integer maxLength)

Set max length.

Parameters:

maxLength - Max length.

getProperties

public Map<String,Object> getProperties()

Object properties.

Returns:

Object properties.

valueOf

public static RamlType valueOf(String name)

Get a RAML type from string.

Parameters:

name - String name.

Returns:

RAML type.

isObject

public boolean isObject()

True if this type is an object.

Returns:

True if this type is an object.

getExample

public Object getExample()

Example type.

Returns:

Example type.

setExample

public void setExample(Object example)

Set example type.

Parameters:

example - Example type.

toArray

public RamlType toArray()

Build/make an array.

Returns:

An array of this type.