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.io.charset;
019
020import java.nio.charset.Charset;
021import java.nio.charset.CharsetEncoder;
022import java.util.function.Supplier;
023
024/**
025 * Works with {@link CharsetEncoder}.
026 *
027 * @since 2.12.0
028 */
029public final class CharsetEncoders {
030
031    /**
032     * Returns the given non-null CharsetEncoder or a new default CharsetEncoder.
033     * <p>
034     * Null input maps to the virtual machine's {@link Charset#defaultCharset() default charset} decoder.
035     * </p>
036     *
037     * @param charsetEncoder The CharsetEncoder to test.
038     * @return the given non-null CharsetEncoder or a new default CharsetEncoder.
039     */
040    public static CharsetEncoder toCharsetEncoder(final CharsetEncoder charsetEncoder) {
041        return toCharsetEncoder(charsetEncoder, () -> Charset.defaultCharset().newEncoder());
042    }
043
044    /**
045     * Returns the given non-null CharsetEncoder or a new default CharsetEncoder.
046     *
047     * @param charsetEncoder The CharsetEncoder to test.
048     * @param defaultSupplier The CharsetEncoder supplier to get when charsetEncoder is null.
049     * @return the given non-null CharsetEncoder or a new default CharsetEncoder.
050     * @since 2.13.0
051     */
052    public static CharsetEncoder toCharsetEncoder(final CharsetEncoder charsetEncoder, final Supplier<CharsetEncoder> defaultSupplier) {
053        return charsetEncoder != null ? charsetEncoder : defaultSupplier.get();
054    }
055
056    /** No instances. */
057    private CharsetEncoders() {
058        // No instances.
059    }
060
061}