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.encoders;
014
015import java.io.*;
016
017/**
018 * Encoder for handling <js>"identity"</js> encoding and decoding.
019 *
020 * <p>
021 * Identity encoding is just another name for no encoding at all.
022 *
023 * <h5 class='section'>Notes:</h5><ul>
024 *    <li class='note'>This class is thread safe and reusable.
025 * </ul>
026 *
027 * <h5 class='section'>See Also:</h5><ul>
028 *    <li class='link'><a class="doclink" href="../../../../index.html#jm.Encoders">Encoders</a>
029
030 * </ul>
031 */
032public class IdentityEncoder extends Encoder {
033
034   /** Singleton */
035   public static final IdentityEncoder INSTANCE = new IdentityEncoder();
036
037   /** Constructor. */
038   public IdentityEncoder() {}
039
040   @Override /* Encoder */
041   public InputStream getInputStream(InputStream is) throws IOException {
042      return is;
043   }
044
045   @Override /* Encoder */
046   public OutputStream getOutputStream(OutputStream os) throws IOException {
047      return os;
048   }
049
050   /**
051    * Returns <code>[<js>"identity"</js>]</code>.
052    */
053   @Override /* Encoder */
054   public String[] getCodings() {
055      return new String[]{"identity"};
056   }
057}