org.raml.v2.model.v10.datamodel

Interface TypeDeclaration

All Superinterfaces:

AbstractWrapperNode, Annotable, BasicFragmentNode, BasicNode

All Known Subinterfaces:

ArrayTypeDeclaration, BooleanTypeDeclaration, DateOnlyTypeDeclaration, DateTimeOnlyTypeDeclaration, DateTimeTypeDeclaration, DateTypeDeclaration, FileTypeDeclaration, IntegerTypeDeclaration, NumberTypeDeclaration, ObjectTypeDeclaration, StringTypeDeclaration, TimeOnlyTypeDeclaration, UnionTypeDeclaration

public interface TypeDeclaration
extends Annotable

Method Summary

Methods

Modifier and Type	Method and Description
List<AnnotationTarget>	allowedTargets() Restrictions on where annotations of this type can be applied.
Object	defaultValue() Provides default value for a property
String	description() A longer, human-friendly description of the type
String	displayName() The displayName attribute specifies the type display name.
ExampleSpec	example() An example of this type instance represented as string or yaml map/sequence.
List<ExampleSpec>	examples() An example of this type instance represented as string.
List<TypeDeclaration>	facets() When extending from a type you can define new facets (which can then be set to concrete values by subtypes).
TypeInstance	fixedFacets() Returns facets fixed by the type.
Boolean	isAnnotation() Whether the type represents annotation
ModelLocation	location() Location of the parameter (can not be edited by user)
LocationKind	locationKind() Kind of location
String	name() name of the parameter
Boolean	repeat() The repeat attribute specifies that the parameter can be repeated.
Boolean	required() Sets if property is optional or not
String	schema() Alias for the equivalent "type" property, for compatibility with RAML 0.8.
String	schemaContent() Returns schema content for the cases when schema is inlined, when schema is included, and when schema is a reference.
TypeInstance	structuredExample() Returns object representation of example, if possible
List<String>	type() A base type which the current type extends, or more generally a type expression.
XMLFacetInfo	xml()

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

annotations

Methods inherited from interface org.raml.v2.model.v10.fragment.BasicFragmentNode

fragment

Methods inherited from interface org.raml.v2.model.v10.core.BasicNode

meta, optional, optionalProperties, parent, toJSON

Method Detail

name

String name()

name of the parameter

displayName

String displayName()

The displayName attribute specifies the type display name. It is a friendly name used only for display or documentation purposes. If displayName is not specified, it defaults to the element's key (the name of the property itself).

facets

List<TypeDeclaration> facets()

When extending from a type you can define new facets (which can then be set to concrete values by subtypes).

schema

String schema()

Alias for the equivalent "type" property, for compatibility with RAML 0.8. Deprecated - API definitions should use the "type" property, as the "schema" alias for that property name may be removed in a future RAML version. The "type" property allows for XML and JSON schemas.

type

List<String> type()

A base type which the current type extends, or more generally a type expression.

location

ModelLocation location()

Location of the parameter (can not be edited by user)

locationKind

LocationKind locationKind()

Kind of location

defaultValue

Object defaultValue()

Provides default value for a property

example

ExampleSpec example()

An example of this type instance represented as string or yaml map/sequence. This can be used, e.g., by documentation generators to generate sample values for an object of this type. Cannot be present if the examples property is present.

examples

List<ExampleSpec> examples()

An example of this type instance represented as string. This can be used, e.g., by documentation generators to generate sample values for an object of this type. Cannot be present if the example property is present.

repeat

Boolean repeat()

The repeat attribute specifies that the parameter can be repeated. If the parameter can be used multiple times, the repeat parameter value MUST be set to 'true'. Otherwise, the default value is 'false' and the parameter may not be repeated.

required

Boolean required()

Sets if property is optional or not

description

String description()

A longer, human-friendly description of the type

xml

XMLFacetInfo xml()

allowedTargets

List<AnnotationTarget> allowedTargets()

Restrictions on where annotations of this type can be applied. If this property is specified, annotations of this type may only be applied on a property corresponding to one of the target names specified as the value of this property.

isAnnotation

Boolean isAnnotation()

Whether the type represents annotation

fixedFacets

TypeInstance fixedFacets()

Returns facets fixed by the type. Value is an object with properties named after facets fixed. Value of each property is a value of the corresponding facet.

schemaContent

String schemaContent()

Returns schema content for the cases when schema is inlined, when schema is included, and when schema is a reference.

structuredExample

TypeInstance structuredExample()

Returns object representation of example, if possible