001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.marshall.encoders;
018
019import static org.apache.juneau.commons.utils.Shorts.*;
020
021import java.io.*;
022
023/**
024 * Encoder for handling <js>"identity"</js> encoding and decoding.
025 *
026 * <p>
027 * Identity encoding is just another name for no encoding at all.
028 *
029 * <h5 class='section'>Notes:</h5><ul>
030 *    <li class='note'>This class is thread safe and reusable.
031 * </ul>
032 *
033 * <h5 class='section'>See Also:</h5><ul>
034 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/MarshallEncoders">Encoders</a>
035
036 * </ul>
037 */
038public class IdentityEncoder extends Encoder {
039
040   /** Singleton */
041   public static final IdentityEncoder INSTANCE = new IdentityEncoder();
042
043   /** Constructor. */
044   public IdentityEncoder() {
045      // No-op: Intentional empty constructor
046   }
047
048   /**
049    * Returns <code>[<js>"identity"</js>]</code>.
050    */
051   @Override /* Overridden from Encoder */
052   public String[] getCodings() { return a("identity"); }
053
054   @Override /* Overridden from Encoder */
055   public InputStream getInputStream(InputStream is) throws IOException {
056      return is;
057   }
058
059   @Override /* Overridden from Encoder */
060   public OutputStream getOutputStream(OutputStream os) throws IOException {
061      return os;
062   }
063}