org.springframework.hateoas

Interface AffordanceModel.PropertyMetadata

Enclosing class:

AffordanceModel

public static interface AffordanceModel.PropertyMetadata

Metadata about the property model of a representation.

Author:

Oliver Drotbohm

Method Summary

Modifier and Type	Method and Description
String	getName() The name of the property.
Optional<String>	getPattern() Returns the (regular expression) pattern the property has to adhere to.
ResolvableType	getType() Return the type of the property.
default boolean	hasName(String name) Whether the property has the given name.
boolean	isReadOnly() Whether the property is read only, i.e. must not be manipulated in requests modifying state.
boolean	isRequired() Whether the property is required to be submitted or always present in the representation returned.

Method Detail

getName

String getName()

The name of the property.

Returns:

will never be null or empty.

hasName

default boolean hasName(String name)

Whether the property has the given name.

Parameters:

name - must not be null or empty.

Returns:

isRequired

boolean isRequired()

Whether the property is required to be submitted or always present in the representation returned.

Returns:

isReadOnly

boolean isReadOnly()

Whether the property is read only, i.e. must not be manipulated in requests modifying state.

Returns:

getPattern

Optional<String> getPattern()

Returns the (regular expression) pattern the property has to adhere to.

Returns:

will never be null.

getType

ResolvableType getType()

Return the type of the property. If no type can be determined, return Object.

Returns: