csw.params.core.formats

Interface JsonSupport

All Superinterfaces:

MiscJsonFormats

All Known Implementing Classes:

JavaJsonSupport$, JsonSupport$

public interface JsonSupport
extends MiscJsonFormats

Supports conversion of commands, state variables and events to/from JSON

Method Summary

Modifier and Type	Method and Description
play.api.libs.json.OFormat<Command>	commandFormat()
play.api.libs.json.Reads<ControlCommand>	controlCommandFormat()
play.api.libs.json.OFormat<Event>	eventFormat()
<A extends Event> A	readEvent(play.api.libs.json.JsValue json) Reads an event back from JSON
Result	readResult(play.api.libs.json.JsValue json) Reads a Result back from JSON
<T> T	reads(play.api.libs.json.JsValue x, play.api.libs.json.Reads<T> evidence$2)
<A extends Command> A	readSequenceCommand(play.api.libs.json.JsValue json) Reads a SequenceCommand back from JSON
<A extends csw.params.core.states.StateVariable.StateVariable> A	readStateVariable(play.api.libs.json.JsValue json) Reads a StateVariable back from JSON
play.api.libs.json.Reads<SequenceCommand>	sequenceCommandFormat()
play.api.libs.json.OFormat<csw.params.core.states.StateVariable.StateVariable>	stateVariableFormat()
<A extends Event> play.api.libs.json.JsValue	writeEvent(A event) Writes an event to JSON
play.api.libs.json.JsValue	writeResult(Result result) Writes a Result to JSON
<T> play.api.libs.json.JsValue	writes(T x, play.api.libs.json.Writes<T> evidence$1)
<A extends Command> play.api.libs.json.JsValue	writeSequenceCommand(A result) Writes a SequenceParameterSet to JSON
<A extends csw.params.core.states.StateVariable.StateVariable> play.api.libs.json.JsValue	writeStateVariable(A stateVariable) Writes a state variable to JSON

Methods inherited from interface csw.params.core.formats.MiscJsonFormats

booleanFormat, byteFormat, characterFormat, charFormat, doubleFormat, floatFormat, formatFactory, integerFormat, longFormat, optionFormat, shortFormat, timestampFormat

Method Detail

writes

<T> play.api.libs.json.JsValue writes(T x,
                                      play.api.libs.json.Writes<T> evidence$1)

reads

<T> T reads(play.api.libs.json.JsValue x,
            play.api.libs.json.Reads<T> evidence$2)

commandFormat

play.api.libs.json.OFormat<Command> commandFormat()

stateVariableFormat

play.api.libs.json.OFormat<csw.params.core.states.StateVariable.StateVariable> stateVariableFormat()

eventFormat

play.api.libs.json.OFormat<Event> eventFormat()

sequenceCommandFormat

play.api.libs.json.Reads<SequenceCommand> sequenceCommandFormat()

controlCommandFormat

play.api.libs.json.Reads<ControlCommand> controlCommandFormat()

writeSequenceCommand

<A extends Command> play.api.libs.json.JsValue writeSequenceCommand(A result)

Writes a SequenceParameterSet to JSON

Parameters:

result - any instance of SequenceCommand

Returns:

a JsValue object representing the SequenceCommand

readSequenceCommand

<A extends Command> A readSequenceCommand(play.api.libs.json.JsValue json)

Reads a SequenceCommand back from JSON

Parameters:

json - the parsed JSON

Returns:

an instance of the given SequenceCommand type, or an exception if the JSON is not valid for that type

writeStateVariable

<A extends csw.params.core.states.StateVariable.StateVariable> play.api.libs.json.JsValue writeStateVariable(A stateVariable)

Writes a state variable to JSON

Parameters:

stateVariable - any instance of StateVariable

Returns:

a JsValue object representing the StateVariable

readStateVariable

<A extends csw.params.core.states.StateVariable.StateVariable> A readStateVariable(play.api.libs.json.JsValue json)

Reads a StateVariable back from JSON

Parameters:

json - the parsed JSON

Returns:

an instance of the given StateVariable, or an exception if the JSON is not valid for that type

writeEvent

<A extends Event> play.api.libs.json.JsValue writeEvent(A event)

Writes an event to JSON

Parameters:

event - any instance of EventType

Returns:

a JsValue object representing the event

readEvent

<A extends Event> A readEvent(play.api.libs.json.JsValue json)

Reads an event back from JSON

Parameters:

json - the parsed JSON

Returns:

an instance of the given event type, or an exception if the JSON is not valid for that type

writeResult

play.api.libs.json.JsValue writeResult(Result result)

Writes a Result to JSON

Parameters:

result - any instance of Result

Returns:

a JsValue object representing the Result

readResult

Result readResult(play.api.libs.json.JsValue json)

Reads a Result back from JSON

Parameters:

json - the parsed JSON

Returns:

an instance of Result, or an exception if the JSON is not valid for that type