001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.marshall;
014
015import org.apache.juneau.json.*;
016
017/**
018 * A pairing of a {@link SimpleJsonSerializer} and {@link JsonParser} into a single class with convenience read/write methods.
019 *
020 * <p>
021 *    The general idea is to combine a single serializer and parser inside a simplified API for reading and writing POJOs.
022 *
023 * <h5 class='figure'>Examples:</h5>
024 * <p class='bcode w800'>
025 *    <jc>// Using instance.</jc>
026 *    SimpleJson json = <jk>new</jk> SimpleJson();
027 *    MyPojo myPojo = json.read(string, MyPojo.<jk>class</jk>);
028 *    String string = json.write(myPojo);
029 * </p>
030 * <p class='bcode w800'>
031 * <jc>// Using DEFAULT instance.</jc>
032 *    MyPojo myPojo = SimpleJson.<jsf>DEFAULT</jsf>.read(string, MyPojo.<jk>class</jk>);
033 *    String string = SimpleJson.<jsf>DEFAULT</jsf>.write(myPojo);
034 * </p>
035 *
036 * <ul class='seealso'>
037 *    <li class='link'>{@doc juneau-marshall.Marshalls}
038 * </ul>
039 */
040public class SimpleJson extends Json {
041
042   /**
043    * Default reusable instance.
044    */
045   public static final SimpleJson DEFAULT = new SimpleJson();
046
047   /**
048    * Default reusable instance, readable format.
049    */
050   public static final SimpleJson DEFAULT_READABLE = new SimpleJson(SimpleJsonSerializer.DEFAULT_READABLE, JsonParser.DEFAULT);
051
052   /**
053    * Constructor.
054    *
055    * @param s
056    *    The serializer to use for serializing output.
057    *    <br>Must not be <jk>null</jk>.
058    * @param p
059    *    The parser to use for parsing input.
060    *    <br>Must not be <jk>null</jk>.
061    */
062   public SimpleJson(JsonSerializer s, JsonParser p) {
063      super(s, p);
064   }
065
066   /**
067    * Constructor.
068    *
069    * <p>
070    * Uses {@link SimpleJsonSerializer#DEFAULT} and {@link JsonParser#DEFAULT}.
071    */
072   public SimpleJson() {
073      this(SimpleJsonSerializer.DEFAULT, JsonParser.DEFAULT);
074   }
075}