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.oapi.*;
016
017/**
018 * A pairing of a {@link OpenApiSerializer} and {@link OpenApiParser} 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 *    OpenApi oapi = <jk>new</jk> OpenApi();
027 *    MyPojo myPojo = oapi.read(string, MyPojo.<jk>class</jk>);
028 *    String string = oapi.write(myPojo);
029 * </p>
030 * <p class='bcode w800'>
031 * <jc>// Using DEFAULT instance.</jc>
032 *    MyPojo myPojo = OpenApi.<jsf>DEFAULT</jsf>.read(string, MyPojo.<jk>class</jk>);
033 *    String string = OpenApi.<jsf>DEFAULT</jsf>.write(myPojo);
034 * </p>
035 *
036 * <h5 class='section'>See Also:</h5>
037 * <ul>
038 *    <li class='link'>{@doc juneau-marshall.Marshalls}
039 * </ul>
040 */
041public class OpenApi extends CharMarshall {
042
043   /**
044    * Default reusable instance.
045    */
046   public static final OpenApi DEFAULT = new OpenApi();
047
048   /**
049    * Constructor.
050    *
051    * @param s
052    *    The serializer to use for serializing output.
053    *    <br>Must not be <jk>null</jk>.
054    * @param p
055    *    The parser to use for parsing input.
056    *    <br>Must not be <jk>null</jk>.
057    */
058   public OpenApi(OpenApiSerializer s, OpenApiParser p) {
059      super(s, p);
060   }
061
062   /**
063    * Constructor.
064    *
065    * <p>
066    * Uses {@link OpenApiSerializer#DEFAULT} and {@link OpenApiParser#DEFAULT}.
067    */
068   public OpenApi() {
069      this(OpenApiSerializer.DEFAULT, OpenApiParser.DEFAULT);
070   }
071}