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.net.util;
19  
20  import java.nio.charset.Charset;
21  
22  /**
23   * Helps to deal with Charsets.
24   *
25   * @since 3.3
26   */
27  public class Charsets {
28  
29      /**
30       * Returns a charset object for the given charset name.
31       *
32       * @param charsetName The name of the requested charset; may be a canonical name, an alias, or null. If null, return the default charset.
33       * @return A charset object for the named charset
34       */
35      public static Charset toCharset(final String charsetName) {
36          return charsetName == null ? Charset.defaultCharset() : Charset.forName(charsetName);
37      }
38  
39      /**
40       * Returns a charset object for the given charset name.
41       *
42       * @param charsetName        The name of the requested charset; may be a canonical name, an alias, or null. If null, return the default charset.
43       * @param defaultCharsetName the charset name to use if the requested charset is null
44       *
45       * @return A charset object for the named charset
46       */
47      public static Charset toCharset(final String charsetName, final String defaultCharsetName) {
48          return charsetName == null ? Charset.forName(defaultCharsetName) : Charset.forName(charsetName);
49      }
50  }