Class BodySchema

java.lang.Object

com.orange.spring.tmf630.affordances.BodySchema

All Implemented Interfaces:

AffordanceProperties.Property<BodySchema>, Serializable

public final class BodySchema
extends Object
implements AffordanceProperties.Property<BodySchema>, Serializable

Describes the expected body structure of the request. Can be used instead of the Fields for a more complex structure.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BodySchema.SchemaType

Constructor Summary

Constructors

Constructor	Description
BodySchema(@NotNull BodySchema.SchemaType schemaType, @NotNull String schemaUrl)

Method Summary

Modifier and Type	Method	Description
@NotNull BodySchema.SchemaType	getSchemaType()
@NotNull String	getSchemaUrl()
@NotNull String	name()
@NotNull BodySchema	value()

Methods inherited from class Object

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

Constructor Details

BodySchema

public BodySchema(@NotNull
 @NotNull BodySchema.SchemaType schemaType,
 @NotNull
 @NotNull String schemaUrl)

Parameters:

schemaType - type of the schema describing the expected body

schemaUrl - a URL where to retrieve the schema

Method Details

getSchemaType

@NotNull
public @NotNull BodySchema.SchemaType getSchemaType()

Returns:

values are "json-schema" or "xsd"

getSchemaUrl

@NotNull
public @NotNull String getSchemaUrl()

Returns:

a URL of a schema describing the expected payload

name

@NotNull
public @NotNull String name()

Specified by:

name in interface AffordanceProperties.Property<BodySchema>

value

@NotNull
public @NotNull BodySchema value()

Specified by:

value in interface AffordanceProperties.Property<BodySchema>