JsonSupport

All Known Implementing Classes:

JsonSupport$
```
public interface JsonSupport
```
Supports conversion of commands, state variables and events to/from JSON

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`play.api.libs.json.Format<CommandName>`	`commandTypeFormat()`
`play.api.libs.json.Format<EventName>`	`eventNameFormat()`
`play.api.libs.json.Format<EventTime>`	`eventTimeFormat()`
`play.api.libs.json.Format<Id>`	`idFormat()`
`play.api.libs.json.Format<scala.Option<ObsId>>`	`obsIdFormat()`
`play.api.libs.json.Format<scala.collection.immutable.Set<Parameter<?>>>`	`paramSetFormat()`
`play.api.libs.json.Format<Prefix>`	`prefixFormat()`
`<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
`<A extends SequenceCommand> A`	`readSequenceCommand(play.api.libs.json.JsValue json)` Reads a SequenceCommand back from JSON
`<A extends csw.messages.params.states.StateVariable.StateVariable> A`	`readStateVariable(play.api.libs.json.JsValue json)` Reads a StateVariable back from JSON
`play.api.libs.json.Format<SequenceCommand>`	`sequenceCommandFormat()`
`play.api.libs.json.Format<StateName>`	`stateNameFormat()`
`scala.runtime.Nothing$`	`unexpectedJsValueError(play.api.libs.json.JsValue x)`
`<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
`<A extends SequenceCommand> play.api.libs.json.JsValue`	`writeSequenceCommand(A result)` Writes a SequenceParameterSet to JSON
`<A extends csw.messages.params.states.StateVariable.StateVariable> play.api.libs.json.JsValue`	`writeStateVariable(A stateVariable)` Writes a state variable to JSON

- Method Detail
  - paramSetFormat
```
play.api.libs.json.Format<scala.collection.immutable.Set<Parameter<?>>> paramSetFormat()
```
  - idFormat
```
play.api.libs.json.Format<Id> idFormat()
```
  - obsIdFormat
```
play.api.libs.json.Format<scala.Option<ObsId>> obsIdFormat()
```
  - prefixFormat
```
play.api.libs.json.Format<Prefix> prefixFormat()
```
  - commandTypeFormat
```
play.api.libs.json.Format<CommandName> commandTypeFormat()
```
  - eventTimeFormat
```
play.api.libs.json.Format<EventTime> eventTimeFormat()
```
  - eventNameFormat
```
play.api.libs.json.Format<EventName> eventNameFormat()
```
  - stateNameFormat
```
play.api.libs.json.Format<StateName> stateNameFormat()
```
  - unexpectedJsValueError
```
scala.runtime.Nothing$ unexpectedJsValueError(play.api.libs.json.JsValue x)
```
  - writeSequenceCommand
```
<A extends SequenceCommand> 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 SequenceCommand> 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
  - sequenceCommandFormat
```
play.api.libs.json.Format<SequenceCommand> sequenceCommandFormat()
```
  - writeStateVariable
```
<A extends csw.messages.params.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.messages.params.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

Interface JsonSupport

Method Summary

Method Detail

paramSetFormat

idFormat

obsIdFormat

prefixFormat

commandTypeFormat

eventTimeFormat

eventNameFormat

stateNameFormat

unexpectedJsValueError

writeSequenceCommand

readSequenceCommand

sequenceCommandFormat

writeStateVariable

readStateVariable

writeEvent

readEvent

writeResult

readResult