CharsetDecoders.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * The ASF licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *      https://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  17. package org.apache.commons.io.charset;

  18. import java.nio.charset.Charset;
  19. import java.nio.charset.CharsetDecoder;

  20. /**
  21.  * Works with {@link CharsetDecoder}.
  22.  *
  23.  * @since 2.12.0
  24.  */
  25. public final class CharsetDecoders {

  26.     /**
  27.      * Returns the given non-null CharsetDecoder or a new default CharsetDecoder.
  28.      * <p>
  29.      * Null input maps to the virtual machine's {@link Charset#defaultCharset() default charset} decoder.
  30.      * </p>
  31.      *
  32.      * @param charsetDecoder The CharsetDecoder to test.
  33.      * @return the given non-null CharsetDecoder or a new default CharsetDecoder.
  34.      */
  35.     public static CharsetDecoder toCharsetDecoder(final CharsetDecoder charsetDecoder) {
  36.         return charsetDecoder != null ? charsetDecoder : Charset.defaultCharset().newDecoder();
  37.     }

  38.     /** No instances. */
  39.     private CharsetDecoders() {
  40.         // No instances.
  41.     }
  42. }