JsonConstants (Vaadin Platform (vaadin-platform-javadoc) 20.0.0 API)

java.lang.Object
- com.vaadin.flow.shared.JsonConstants

All Implemented Interfaces:

Serializable
```
public class JsonConstants
extends Object
implements Serializable
```
A utility class providing constants for JSON related features.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CHANGE_FEATURE` Key holding the feature of a change.
`static String`	`CHANGE_FEATURE_TYPE` Key holding the feature type.
`static String`	`CHANGE_MAP_KEY` Key holding the map key of the change.
`static String`	`CHANGE_NODE` Key holding id of the node affected by a change.
`static String`	`CHANGE_PUT_NODE_VALUE` Key holder the node value of a put change.
`static String`	`CHANGE_PUT_VALUE` Key holding the value of a put change.
`static String`	`CHANGE_SPLICE_ADD` Key holding values to add for a splice.
`static String`	`CHANGE_SPLICE_ADD_NODES` Key holding nodes to add for a splice.
`static String`	`CHANGE_SPLICE_INDEX` Key holding the index of a splice.
`static String`	`CHANGE_SPLICE_REMOVE` Key holding the number of items to remove for a splice.
`static String`	`CHANGE_TYPE` Key holding the type of a change.
`static String`	`CHANGE_TYPE_ATTACH` Change type for attaching nodes.
`static String`	`CHANGE_TYPE_CLEAR` Change type for list clear changes.
`static String`	`CHANGE_TYPE_DETACH` Change type for detaching nodes.
`static String`	`CHANGE_TYPE_NOOP` Change type for empty change (populate the feature on the client side only).
`static String`	`CHANGE_TYPE_PUT` Change type for map put changes.
`static String`	`CHANGE_TYPE_REMOVE` Change type for map remove changes.
`static String`	`CHANGE_TYPE_SPLICE` Change type for list splice changes.
`static String`	`EVENT_DATA_PHASE` Key holding the debounce phase for an event data map from the client.
`static String`	`EVENT_PHASE_INTERMEDIATE` Character used for representing `DebouncePhase.INTERMEDIATE`.
`static String`	`EVENT_PHASE_LEADING` Character used for representing `DebouncePhase.LEADING`.
`static String`	`EVENT_PHASE_TRAILING` Character used for representing `DebouncePhase.TRAILING`.
`static String`	`JSON_CONTENT_TYPE` The content type for JSON requests/responses.
`static String`	`META_ASYNC` Key used when the message is sent asynchronously via push channel.
`static String`	`META_SESSION_EXPIRED` Key used when informing the client side that the session has expired.
`static String`	`RPC_ATTACH_ASSIGNED_ID` Key used to hold assigned state node identifier for attach existing element request.
`static String`	`RPC_ATTACH_EXISTING_ELEMENT` Type value for attach existing element server callback.
`static String`	`RPC_ATTACH_EXISTING_ELEMENT_BY_ID` Type value for attach existing element server callback.
`static String`	`RPC_ATTACH_ID` Key used to hold id of the element for attach existing element request.
`static String`	`RPC_ATTACH_INDEX` Key used to hold index of server side element for attach existing element request.
`static String`	`RPC_ATTACH_REQUESTED_ID` Key used to hold requested state node identifier for attach existing element request.
`static String`	`RPC_ATTACH_TAG_NAME` Key used to hold tag name for attach existing element request.
`static String`	`RPC_CHANNEL` Key for the channel id in return channel messages.
`static String`	`RPC_CHANNEL_ARGUMENTS` Key for the arguments array in return channel messages.
`static String`	`RPC_EVENT_DATA` Key holding the event data in event messages sent from the client.
`static String`	`RPC_EVENT_TYPE` Key holding the event type in event messages sent from the client.
`static String`	`RPC_FEATURE` Key used to hold the feature id when synchronizing node values.
`static String`	`RPC_NAVIGATION_LOCATION` Key used to hold the location in a navigation message.
`static String`	`RPC_NAVIGATION_ROUTERLINK` Key used in navigation messages triggered by a router link.
`static String`	`RPC_NAVIGATION_STATE` Key used to hold the state in a navigation message.
`static String`	`RPC_NODE` Key holding the node in messages sent from the client.
`static String`	`RPC_PROMISE_CALLBACK_NAME` Name of the $server property that is used to track pending promises.
`static String`	`RPC_PROPERTY` Key used to hold the name of the synchronized property.
`static String`	`RPC_PROPERTY_VALUE` Key used to hold the value of the synchronized property.
`static String`	`RPC_PUBLISHED_SERVER_EVENT_HANDLER` Type value for events sent from the client to an event handler published on the server.
`static String`	`RPC_TEMPLATE_EVENT_ARGS` Key used to hold the argument values for server side method call.
`static String`	`RPC_TEMPLATE_EVENT_METHOD_NAME` Key used to hold the server side method name in template event messages sent from the client.
`static String`	`RPC_TEMPLATE_EVENT_PROMISE` Key used to hold the promise id for a server side method call.
`static String`	`RPC_TYPE` Key holding the type in of messages sent from the client.
`static String`	`RPC_TYPE_CHANNEL` RPC type value used for return channel messages.
`static String`	`RPC_TYPE_EVENT` Type value for events sent from the client.
`static String`	`RPC_TYPE_MAP_SYNC` Type value for model map synchronizations sent from the client.
`static String`	`RPC_TYPE_NAVIGATION` Type value for navigation events from the client.
`static String`	`SYNCHRONIZE_PROPERTY_TOKEN` Token used as an event data expression to represent that properties should be synchronized.
`static String`	`UIDL_KEY_EXECUTE` Key used for data related to `Page.executeJs(String, Serializable...)` in UIDL messages.

Constructor Summary

Constructors
Constructor and Description

JsonConstants()

Constructors
Constructor and Description
`JsonConstants()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JSON_CONTENT_TYPE
```
public static final String JSON_CONTENT_TYPE
```
    The content type for JSON requests/responses.
    
    See Also:
    
    Constant Field Values
  - CHANGE_NODE
```
public static final String CHANGE_NODE
```
    Key holding id of the node affected by a change.
    
    See Also:
    
    Constant Field Values
  - CHANGE_TYPE
```
public static final String CHANGE_TYPE
```
    Key holding the type of a change.
    
    See Also:
    
    Constant Field Values
  - CHANGE_TYPE_NOOP
```
public static final String CHANGE_TYPE_NOOP
```
    Change type for empty change (populate the feature on the client side only).
    
    See Also:
    
    Constant Field Values
  - CHANGE_TYPE_ATTACH
```
public static final String CHANGE_TYPE_ATTACH
```
    Change type for attaching nodes.
    
    See Also:
    
    Constant Field Values
  - CHANGE_TYPE_DETACH
```
public static final String CHANGE_TYPE_DETACH
```
    Change type for detaching nodes.
    
    See Also:
    
    Constant Field Values
  - CHANGE_TYPE_SPLICE
```
public static final String CHANGE_TYPE_SPLICE
```
    Change type for list splice changes.
    
    See Also:
    
    Constant Field Values
  - CHANGE_TYPE_PUT
```
public static final String CHANGE_TYPE_PUT
```
    Change type for map put changes.
    
    See Also:
    
    Constant Field Values
  - CHANGE_TYPE_REMOVE
```
public static final String CHANGE_TYPE_REMOVE
```
    Change type for map remove changes.
    
    See Also:
    
    Constant Field Values
  - CHANGE_TYPE_CLEAR
```
public static final String CHANGE_TYPE_CLEAR
```
    Change type for list clear changes.
    
    See Also:
    
    Constant Field Values
  - CHANGE_FEATURE
```
public static final String CHANGE_FEATURE
```
    Key holding the feature of a change.
    
    See Also:
    
    Constant Field Values
  - CHANGE_FEATURE_TYPE
```
public static final String CHANGE_FEATURE_TYPE
```
    Key holding the feature type.
    
    See Also:
    
    Constant Field Values
  - CHANGE_MAP_KEY
```
public static final String CHANGE_MAP_KEY
```
    Key holding the map key of the change.
    
    See Also:
    
    Constant Field Values
  - CHANGE_SPLICE_ADD_NODES
```
public static final String CHANGE_SPLICE_ADD_NODES
```
    Key holding nodes to add for a splice.
    
    See Also:
    
    Constant Field Values
  - CHANGE_SPLICE_ADD
```
public static final String CHANGE_SPLICE_ADD
```
    Key holding values to add for a splice.
    
    See Also:
    
    Constant Field Values
  - CHANGE_SPLICE_REMOVE
```
public static final String CHANGE_SPLICE_REMOVE
```
    Key holding the number of items to remove for a splice.
    
    See Also:
    
    Constant Field Values
  - CHANGE_SPLICE_INDEX
```
public static final String CHANGE_SPLICE_INDEX
```
    Key holding the index of a splice.
    
    See Also:
    
    Constant Field Values
  - CHANGE_PUT_VALUE
```
public static final String CHANGE_PUT_VALUE
```
    Key holding the value of a put change.
    
    See Also:
    
    Constant Field Values
  - CHANGE_PUT_NODE_VALUE
```
public static final String CHANGE_PUT_NODE_VALUE
```
    Key holder the node value of a put change.
    
    See Also:
    
    Constant Field Values
  - RPC_TYPE
```
public static final String RPC_TYPE
```
    Key holding the type in of messages sent from the client.
    
    See Also:
    
    Constant Field Values
  - RPC_TYPE_EVENT
```
public static final String RPC_TYPE_EVENT
```
    Type value for events sent from the client.
    
    See Also:
    
    Constant Field Values
  - RPC_TYPE_NAVIGATION
```
public static final String RPC_TYPE_NAVIGATION
```
    Type value for navigation events from the client.
    
    See Also:
    
    Constant Field Values
  - RPC_NODE
```
public static final String RPC_NODE
```
    Key holding the node in messages sent from the client.
    
    See Also:
    
    Constant Field Values
  - RPC_EVENT_TYPE
```
public static final String RPC_EVENT_TYPE
```
    Key holding the event type in event messages sent from the client.
    
    See Also:
    
    Constant Field Values
  - RPC_TYPE_MAP_SYNC
```
public static final String RPC_TYPE_MAP_SYNC
```
    Type value for model map synchronizations sent from the client.
    
    See Also:
    
    Constant Field Values
  - RPC_EVENT_DATA
```
public static final String RPC_EVENT_DATA
```
    Key holding the event data in event messages sent from the client.
    
    See Also:
    
    Constant Field Values
  - UIDL_KEY_EXECUTE
```
public static final String UIDL_KEY_EXECUTE
```
    Key used for data related to Page.executeJs(String, Serializable...) in UIDL messages.
    
    See Also:
    
    Constant Field Values
  - RPC_FEATURE
```
public static final String RPC_FEATURE
```
    Key used to hold the feature id when synchronizing node values.
    
    See Also:
    
    Constant Field Values
  - RPC_PROPERTY
```
public static final String RPC_PROPERTY
```
    Key used to hold the name of the synchronized property.
    
    See Also:
    
    Constant Field Values
  - RPC_PROPERTY_VALUE
```
public static final String RPC_PROPERTY_VALUE
```
    Key used to hold the value of the synchronized property.
    
    See Also:
    
    Constant Field Values
  - RPC_NAVIGATION_LOCATION
```
public static final String RPC_NAVIGATION_LOCATION
```
    Key used to hold the location in a navigation message.
    
    See Also:
    
    Constant Field Values
  - RPC_NAVIGATION_STATE
```
public static final String RPC_NAVIGATION_STATE
```
    Key used to hold the state in a navigation message.
    
    See Also:
    
    Constant Field Values
  - RPC_NAVIGATION_ROUTERLINK
```
public static final String RPC_NAVIGATION_ROUTERLINK
```
    Key used in navigation messages triggered by a router link.
    
    See Also:
    
    Constant Field Values
  - RPC_PUBLISHED_SERVER_EVENT_HANDLER
```
public static final String RPC_PUBLISHED_SERVER_EVENT_HANDLER
```
    Type value for events sent from the client to an event handler published on the server.
    
    See Also:
    
    Constant Field Values
  - RPC_TEMPLATE_EVENT_METHOD_NAME
```
public static final String RPC_TEMPLATE_EVENT_METHOD_NAME
```
    Key used to hold the server side method name in template event messages sent from the client.
    
    See Also:
    
    Constant Field Values
  - RPC_TEMPLATE_EVENT_ARGS
```
public static final String RPC_TEMPLATE_EVENT_ARGS
```
    Key used to hold the argument values for server side method call.
    
    See Also:
    
    RPC_TEMPLATE_EVENT_METHOD_NAME, RPC_PUBLISHED_SERVER_EVENT_HANDLER, Constant Field Values
  - RPC_TEMPLATE_EVENT_PROMISE
```
public static final String RPC_TEMPLATE_EVENT_PROMISE
```
    Key used to hold the promise id for a server side method call.
    
    See Also:
    
    Constant Field Values
  - RPC_PROMISE_CALLBACK_NAME
```
public static final String RPC_PROMISE_CALLBACK_NAME
```
    Name of the $server property that is used to track pending promises. The name is chosen to avoid conflicts with genuine $server method names.
    
    See Also:
    
    Constant Field Values
  - RPC_ATTACH_EXISTING_ELEMENT
```
public static final String RPC_ATTACH_EXISTING_ELEMENT
```
    Type value for attach existing element server callback.
    
    See Also:
    
    RPC_ATTACH_ASSIGNED_ID, RPC_ATTACH_REQUESTED_ID, RPC_ATTACH_TAG_NAME, RPC_ATTACH_INDEX, Constant Field Values
  - RPC_ATTACH_EXISTING_ELEMENT_BY_ID
```
public static final String RPC_ATTACH_EXISTING_ELEMENT_BY_ID
```
    Type value for attach existing element server callback.
    
    See Also:
    
    RPC_ATTACH_ASSIGNED_ID, RPC_ATTACH_REQUESTED_ID, RPC_ATTACH_TAG_NAME, RPC_ATTACH_ID, Constant Field Values
  - RPC_ATTACH_REQUESTED_ID
```
public static final String RPC_ATTACH_REQUESTED_ID
```
    Key used to hold requested state node identifier for attach existing element request.
    
    See Also:
    
    Constant Field Values
  - RPC_ATTACH_ASSIGNED_ID
```
public static final String RPC_ATTACH_ASSIGNED_ID
```
    Key used to hold assigned state node identifier for attach existing element request.
    
    See Also:
    
    Constant Field Values
  - RPC_ATTACH_TAG_NAME
```
public static final String RPC_ATTACH_TAG_NAME
```
    Key used to hold tag name for attach existing element request.
    
    See Also:
    
    Constant Field Values
  - RPC_ATTACH_INDEX
```
public static final String RPC_ATTACH_INDEX
```
    Key used to hold index of server side element for attach existing element request.
    
    See Also:
    
    Constant Field Values
  - RPC_ATTACH_ID
```
public static final String RPC_ATTACH_ID
```
    Key used to hold id of the element for attach existing element request.
    
    See Also:
    
    Constant Field Values
  - META_SESSION_EXPIRED
```
public static final String META_SESSION_EXPIRED
```
    Key used when informing the client side that the session has expired.
    
    See Also:
    
    Constant Field Values
  - META_ASYNC
```
public static final String META_ASYNC
```
    Key used when the message is sent asynchronously via push channel.
    
    See Also:
    
    Constant Field Values
  - EVENT_DATA_PHASE
```
public static final String EVENT_DATA_PHASE
```
    Key holding the debounce phase for an event data map from the client.
    
    See Also:
    
    Constant Field Values
  - EVENT_PHASE_LEADING
```
public static final String EVENT_PHASE_LEADING
```
    Character used for representing DebouncePhase.LEADING.
    
    See Also:
    
    Constant Field Values
  - EVENT_PHASE_INTERMEDIATE
```
public static final String EVENT_PHASE_INTERMEDIATE
```
    Character used for representing DebouncePhase.INTERMEDIATE.
    
    See Also:
    
    Constant Field Values
  - EVENT_PHASE_TRAILING
```
public static final String EVENT_PHASE_TRAILING
```
    Character used for representing DebouncePhase.TRAILING.
    
    See Also:
    
    Constant Field Values
  - SYNCHRONIZE_PROPERTY_TOKEN
```
public static final String SYNCHRONIZE_PROPERTY_TOKEN
```
    Token used as an event data expression to represent that properties should be synchronized. The token is chosen to avoid collisions with regular event data expressions by using a character that cannot be the start of a valid JS expression.
    
    See Also:
    
    Constant Field Values
  - RPC_TYPE_CHANNEL
```
public static final String RPC_TYPE_CHANNEL
```
    RPC type value used for return channel messages.
    
    See Also:
    
    Constant Field Values
  - RPC_CHANNEL
```
public static final String RPC_CHANNEL
```
    Key for the channel id in return channel messages.
    
    See Also:
    
    Constant Field Values
  - RPC_CHANNEL_ARGUMENTS
```
public static final String RPC_CHANNEL_ARGUMENTS
```
    Key for the arguments array in return channel messages.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JsonConstants
```
public JsonConstants()
```

Class JsonConstants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_CONTENT_TYPE

CHANGE_NODE

CHANGE_TYPE

CHANGE_TYPE_NOOP

CHANGE_TYPE_ATTACH

CHANGE_TYPE_DETACH

CHANGE_TYPE_SPLICE

CHANGE_TYPE_PUT

CHANGE_TYPE_REMOVE

CHANGE_TYPE_CLEAR

CHANGE_FEATURE

CHANGE_FEATURE_TYPE

CHANGE_MAP_KEY

CHANGE_SPLICE_ADD_NODES

CHANGE_SPLICE_ADD

CHANGE_SPLICE_REMOVE

CHANGE_SPLICE_INDEX

CHANGE_PUT_VALUE

CHANGE_PUT_NODE_VALUE

RPC_TYPE

RPC_TYPE_EVENT

RPC_TYPE_NAVIGATION

RPC_NODE

RPC_EVENT_TYPE

RPC_TYPE_MAP_SYNC

RPC_EVENT_DATA

UIDL_KEY_EXECUTE

RPC_FEATURE

RPC_PROPERTY

RPC_PROPERTY_VALUE

RPC_NAVIGATION_LOCATION

RPC_NAVIGATION_STATE

RPC_NAVIGATION_ROUTERLINK

RPC_PUBLISHED_SERVER_EVENT_HANDLER

RPC_TEMPLATE_EVENT_METHOD_NAME

RPC_TEMPLATE_EVENT_ARGS

RPC_TEMPLATE_EVENT_PROMISE

RPC_PROMISE_CALLBACK_NAME

RPC_ATTACH_EXISTING_ELEMENT

RPC_ATTACH_EXISTING_ELEMENT_BY_ID

RPC_ATTACH_REQUESTED_ID

RPC_ATTACH_ASSIGNED_ID

RPC_ATTACH_TAG_NAME

RPC_ATTACH_INDEX

RPC_ATTACH_ID

META_SESSION_EXPIRED

META_ASYNC

EVENT_DATA_PHASE

EVENT_PHASE_LEADING

EVENT_PHASE_INTERMEDIATE

EVENT_PHASE_TRAILING

SYNCHRONIZE_PROPERTY_TOKEN

RPC_TYPE_CHANNEL

RPC_CHANNEL

RPC_CHANNEL_ARGUMENTS

Constructor Detail

JsonConstants