org.raml.v2.api.model.v10.datamodel

Interface NumberTypeDeclaration

All Superinterfaces:

Annotable, TypeDeclaration

All Known Subinterfaces:

IntegerTypeDeclaration

public interface NumberTypeDeclaration
extends TypeDeclaration

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	enumValues() (Optional, applicable only for parameters of type string) The enum attribute provides an enumeration of the parameter's valid values.
String	format() Value format
Double	maximum() (Optional, applicable only for parameters of type number or integer) The maximum attribute specifies the parameter's maximum value.
Double	minimum() (Optional, applicable only for parameters of type number or integer) The minimum attribute specifies the parameter's minimum value.
Double	multipleOf() A numeric instance is valid against "multipleOf" if the result of the division of the instance by this keyword's value is an integer.

Methods inherited from interface org.raml.v2.api.model.v10.datamodel.TypeDeclaration

allowedTargets, defaultValue, description, displayName, example, examples, fixedFacets, isAnnotation, name, required, schema, schemaContent, type, validate

Methods inherited from interface org.raml.v2.api.model.v10.common.Annotable

annotations

Method Detail

minimum

Double minimum()

(Optional, applicable only for parameters of type number or integer) The minimum attribute specifies the parameter's minimum value.

maximum

Double maximum()

(Optional, applicable only for parameters of type number or integer) The maximum attribute specifies the parameter's maximum value.

enumValues

List<String> enumValues()

(Optional, applicable only for parameters of type string) The enum attribute provides an enumeration of the parameter's valid values. This MUST be an array. If the enum attribute is defined, API clients and servers MUST verify that a parameter's value matches a value in the enum array. If there is no matching value, the clients and servers MUST treat this as an error.

format

String format()

Value format

multipleOf

Double multipleOf()

A numeric instance is valid against "multipleOf" if the result of the division of the instance by this keyword's value is an integer.