Class 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 Detail

      • JSON_CONTENT_TYPE

        public static final String JSON_CONTENT_TYPE
        The content type for JSON requests/responses.
        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_SPLICE

        public static final String CHANGE_TYPE_SPLICE
        Change type for list splice 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_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_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_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
      • 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_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_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
      • 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
      • MAP_STATE_NODE_EVENT_DATA

        public static final String MAP_STATE_NODE_EVENT_DATA
        Token used as an event data expression or prefix to an event data expression to represent that the state node ID should be fetched for the element, or its closest parent, that corresponds to event.target or the element returned by the evaluated expression.

        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.

        Since:
        9.0
        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()