javax.json.bind.serializer.JsonbSerializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.json.bind-api Show documentation
There is a newer version: 1.0
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2016, 2017 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.json.bind.serializer;

import javax.json.stream.JsonGenerator;

/**
 * Interface representing a custom serializer for given type. Unlike {@link javax.json.bind.adapter.JsonbAdapter}
 * serializer provides more fine grained control over serialization process by writing java object directly into
 * JSON stream using {@link JsonGenerator}. {@link SerializationContext} acts as JSONB runtime, able to serialize
 * any java object provided.
 *
 * Serializers are registered using {@link javax.json.bind.JsonbConfig#withSerializers(JsonbSerializer[])}
 * method or using {@link javax.json.bind.annotation.JsonbTypeSerializer} annotation on type
 *
 * Sample of custom Serializer:
 *  * class Box {
 *     public BoxInner boxInnerObject;
 *     public String name;
 * }
 *
 * class BoxSerializer implements JsonbSerializer<Box> {
 *      public void serialize(Box box, JsonGenerator generator, SerializationContext ctx) {
 *          generator.write("name", box.name);
 *          ctx.serialize("boxInnerObject", generator);
 *      }
 * }
 * 
 *
 * @param  Type to bind serializer for.
 * @see javax.json.bind.JsonbConfig
 * @see javax.json.bind.annotation.JsonbTypeSerializer
 * @see JsonbDeserializer
 * @see javax.json.bind.adapter.JsonbAdapter
 * @since JSON Binding 1.0
 */
public interface JsonbSerializer {

    /**
     * Serializes object into JSON stream.
     *
     * @param obj
     *      Object to serialize.
     * @param generator
     *      JSON generator used to write java object to JSON stream.
     * @param ctx
     *      JSONB mapper context. Use it to serialize sub-objects.
     */
    void serialize(T obj, JsonGenerator generator, SerializationContext ctx);
}