View Javadoc
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    *      http://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  
18  package org.apache.commons.io.charset;
19  
20  import java.nio.charset.Charset;
21  import java.nio.charset.CharsetEncoder;
22  import java.util.function.Supplier;
23  
24  /**
25   * Works with {@link CharsetEncoder}.
26   *
27   * @since 2.12.0
28   */
29  public final class CharsetEncoders {
30  
31      /**
32       * Returns the given non-null CharsetEncoder or a new default CharsetEncoder.
33       *
34       * @param charsetEncoder The CharsetEncoder to test.
35       * @return the given non-null CharsetEncoder or a new default CharsetEncoder.
36       */
37      public static CharsetEncoder toCharsetEncoder(final CharsetEncoder charsetEncoder) {
38          return toCharsetEncoder(charsetEncoder, () -> Charset.defaultCharset().newEncoder());
39      }
40  
41      /**
42       * Returns the given non-null CharsetEncoder or a new default CharsetEncoder.
43       *
44       * @param charsetEncoder The CharsetEncoder to test.
45       * @param defaultSupplier The CharsetEncoder supplier to get when charsetEncoder is null.
46       * @return the given non-null CharsetEncoder or a new default CharsetEncoder.
47       * @since 2.13.0
48       */
49      public static CharsetEncoder toCharsetEncoder(final CharsetEncoder charsetEncoder, final Supplier<CharsetEncoder> defaultSupplier) {
50          return charsetEncoder != null ? charsetEncoder : defaultSupplier.get();
51      }
52  
53      /** No instances. */
54      private CharsetEncoders() {
55          // No instances.
56      }
57  
58  }