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  package org.apache.logging.log4j.core.helpers;
18  
19  import java.nio.charset.Charset;
20  
21  import org.apache.logging.log4j.status.StatusLogger;
22  
23  /**
24   * Charset utilities.
25   */
26  public final class Charsets {
27  
28      private Charsets() {
29      }
30  
31      /**
32       * Gets a Charset, starting with the preferred {@code charsetName} if supported, if not, use UTF-8, if not
33       * supported, use the platform default.
34       *
35       * @param charsetName
36       *            the preferred charset name
37       * @return a Charset, not null.
38       */
39      public static Charset getSupportedCharset(final String charsetName) {
40          Charset charset = null;
41          if (charsetName != null) {
42              if (Charset.isSupported(charsetName)) {
43                  charset = Charset.forName(charsetName);
44              }
45          }
46          if (charset == null) {
47              charset = Charset.isSupported("UTF-8") ? Charset.forName("UTF-8") : Charset.defaultCharset();
48              if (charsetName != null) {
49                  StatusLogger.getLogger().error("Charset " + charsetName + " is not supported for layout, using " +
50                      charset.displayName());
51              }
52          }
53          return charset;
54      }
55  
56  }