Package siren

Provides the classes that grant client applications the ability to leverage the power of the siren specification.

See: Description

Interface Summary

Interface	Description
Builder<T>	Defines the contract that all types choosing to be a Builder must abide by.

Class Summary

Class	Description
Action	Represents an available behavior an entity exposes.
Action.Builder	Constructs an instance of Action.Builder.
EmbeddedLinkSubEntity	A sub-entity containing an href value.
EmbeddedLinkSubEntity.Builder	Constructs an instance of EmbeddedLinkSubEntity.Builder.
EmbeddedRepresentationSubEntity	An embedded entity representation that contains all the characteristics of a typical entity.
EmbeddedRepresentationSubEntity.Builder	Constructs an instance of EmbeddedRepresentationSubEntity.Builder.
Entity	An Entity is a URI-addressable resource that has properties and actions associated with it.
Entity.Builder	Constructs instances of Entity.
EntityBase	Represents the common lineage of all entities.
Field<T>	Represents a control inside of an action.
Field.Builder<T>	Constructs an instance of Field.Builder.
FieldValue<T>	Value objects represent multiple selectable field values.
FieldValue.Builder<T>	Constructs an instance of FieldValue.Builder.
Link	Represent navigational transitions.
Link.Builder	Constructs instances of Link.
Program
Relation

Enum Summary

Enum	Description
FieldType	Identifies the possible field types.
HttpMethod	Identifies the possible HTTP methods.

Package siren Description

Provides the classes that grant client applications the ability to leverage the power of the siren specification. Each siren class instance can be built using a corresponding builder class instance. The builder classes provide fine-grain control, while also exposing an intuitive and terse API. Note that instances of the siren classes (excluding the builder classes) in this package are purposefully immutable. Immutability by itself carries with it it's fair share of benefits, but was further chosen to eliminate the risk of calling code causing incorrect serialization or deserialization of the siren classes. In other words, it was recognized that the action of serializing and deserializing the instances of the siren classes shouldn't alter the state of those instances, justifying immutability as a technique of ensuring this philosophy was enforced.

Since:

9/13/17

Author:

jonfreer