001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.net.util;
019
020import java.nio.charset.Charset;
021
022/**
023 * Helps to deal with Charsets.
024 *
025 * @since 3.3
026 */
027public class Charsets {
028
029    /**
030     * Returns a charset object for the given charset name.
031     *
032     * @param charsetName The name of the requested charset; may be a canonical name, an alias, or null. If null, return the default charset.
033     * @return A charset object for the named charset
034     */
035    public static Charset toCharset(final String charsetName) {
036        return charsetName == null ? Charset.defaultCharset() : Charset.forName(charsetName);
037    }
038
039    /**
040     * Returns a charset object for the given charset name.
041     *
042     * @param charsetName        The name of the requested charset; may be a canonical name, an alias, or null. If null, return the default charset.
043     * @param defaultCharsetName the charset name to use if the requested charset is null
044     *
045     * @return A charset object for the named charset
046     */
047    public static Charset toCharset(final String charsetName, final String defaultCharsetName) {
048        return charsetName == null ? Charset.forName(defaultCharsetName) : Charset.forName(charsetName);
049    }
050
051    /**
052     * Depreacted.
053     *
054     * @deprecated Will be removed in 2.0.
055     */
056    @Deprecated
057    public Charsets() {
058        // empty
059    }
060}