12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273 |
- /*
- * Copyright 2000-2022 Vaadin Ltd.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License. You may obtain a copy of
- * the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- * License for the specific language governing permissions and limitations under
- * the License.
- */
-
- package com.vaadin.client.communication;
-
- import com.vaadin.client.ApplicationConnection;
- import com.vaadin.client.metadata.Type;
-
- import elemental.json.JsonValue;
-
- /**
- * Implementors of this interface knows how to serialize an Object of a given
- * type to JSON and how to deserialize the JSON back into an object.
- * <p>
- * The {@link #serialize(Object, ApplicationConnection)} and
- * {@link #deserialize(Type, JsonValue, ApplicationConnection)} methods must be
- * symmetric so they can be chained and produce the original result (or an equal
- * result).
- * <p>
- * Each {@link JSONSerializer} implementation can handle an object of a single
- * type - see {@link Type#findSerializer()}.
- * <p>
- * This is the client side interface, see
- * com.vaadin.server.communication.JSONSerializer for the server side interface.
- *
- * @since 7.0
- */
- public interface JSONSerializer<T> {
-
- /**
- * Creates and deserializes an object received from the server. Must be
- * compatible with {@link #serialize(Object, ApplicationConnection)} and
- * also with the server side JsonCodec.encode method.
- *
- * @param type
- * the type to deserialize
- * @param jsonValue
- * JSON map from property name to property value
- * @param connection
- * the application connection providing the context
- *
- * @return A deserialized object
- */
- T deserialize(Type type, JsonValue jsonValue,
- ApplicationConnection connection);
-
- /**
- * Serialize the given object into JSON. Must be compatible with
- * {@link #deserialize(Type, JsonValue, ApplicationConnection)} and also
- * with the server side JsonCodec.decodeCustomType method.
- *
- * @param value
- * The object to serialize
- * @param connection
- * the application connection providing the context
- * @return A JSON serialized version of the object
- */
- JsonValue serialize(T value, ApplicationConnection connection);
-
- }
|