com.anrisoftware.resources.texts.internal.texts.SerializableCharset Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of resources-texts Show documentation
Text resources.
The newest version!
/*
 * Copyright 2012-2025 Erwin Müller 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.anrisoftware.resources.texts.internal.texts;

import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.nio.ByteBuffer;
import java.nio.CharBuffer;
import java.nio.charset.Charset;
import java.nio.charset.CharsetDecoder;
import java.nio.charset.CharsetEncoder;
import java.util.Locale;
import java.util.Set;

/**
 * Serialize the specified character set.
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.7
 */
public final class SerializableCharset implements Externalizable {

    /**
     * Decorates the character set for serialization.
     *
     * @param charset the {@link Charset}.
     *
     * @return the {@link SerializableCharset}.
     */
    public static SerializableCharset decorate(Charset charset) {
        return new SerializableCharset(charset);
    }

    /**
     * Decorates the character set for serialization.
     *
     * @param charset the {@link Charset}.
     *
     * @return the {@link SerializableCharset}.
     *
     * @since 2.0
     */
    public static SerializableCharset decorateSerializableCharset(Charset charset) {
        return new SerializableCharset(charset);
    }

    private Charset charset;

    /**
     * For serialization.
     */
    public SerializableCharset() {
    }

    private SerializableCharset(Charset charset) {
        this.charset = charset;
    }

    /**
     * Returns the serialized character set.
     *
     * @return the {@link Charset}.
     */
    public Charset getCharset() {
        return charset;
    }

    /**
     * @see Charset#name()
     * @since 2.6
     * @return the {@link String} name.
     */
    public String name() {
        return charset.name();
    }

    /**
     * @see Charset#aliases()
     * @since 2.6
     * @return the {@link Set} of aliases.
     */
    public Set aliases() {
        return charset.aliases();
    }

    /**
     * @see Charset#displayName()
     * @since 2.6
     * @return the {@link String} display name.
     */
    public String displayName() {
        return charset.displayName();
    }

    /**
     * @see Charset#isRegistered()
     * @since 2.6
     * @return true or false based on {@link Charset#isRegistered()}.
     */
    public boolean isRegistered() {
        return charset.isRegistered();
    }

    /**
     * @param locale the {@link Locale}.
     * @see Charset#displayName(Locale)
     * @since 2.6
     * @return the {@link String} display name.
     */
    public String displayName(Locale locale) {
        return charset.displayName(locale);
    }

    /**
     * @param cs the {@link Charset}.
     * @see Charset#contains(Charset)
     * @since 2.6
     * @return true or false based on {@link Charset#contains(Charset)}.
     */
    public boolean contains(Charset cs) {
        return charset.contains(cs);
    }

    /**
     * @see Charset#newDecoder()
     * @since 2.6
     * @return the {@link CharsetDecoder}
     */
    public CharsetDecoder newDecoder() {
        return charset.newDecoder();
    }

    /**
     * @see Charset#newEncoder()
     * @since 2.6
     * @return the {@link CharsetEncoder}
     */
    public CharsetEncoder newEncoder() {
        return charset.newEncoder();
    }

    /**
     * @see Charset#canEncode()
     * @since 2.6
     * @return true or false based on {@link Charset#canEncode()}.
     */
    public boolean canEncode() {
        return charset.canEncode();
    }

    /**
     * @param bb the {@link ByteBuffer}
     * @see Charset#decode(ByteBuffer)
     * @since 2.6
     * @return the {@link CharBuffer}
     */
    public CharBuffer decode(ByteBuffer bb) {
        return charset.decode(bb);
    }

    /**
     * @param cb the {@link CharBuffer}
     * @see Charset#encode(CharBuffer)
     * @since 2.6
     * @return the {@link ByteBuffer}
     */
    public ByteBuffer encode(CharBuffer cb) {
        return charset.encode(cb);
    }

    /**
     * @param str the {@link String}
     * @see Charset#encode(String)
     * @since 2.6
     * @return {@link ByteBuffer}
     */
    public ByteBuffer encode(String str) {
        return charset.encode(str);
    }

    /**
     * @param that the {@link Charset}
     * @see Charset#compareTo(Charset)
     * @since 2.6
     * @return like {@link Charset#compareTo(Charset)}l
     */
    public int compareTo(Charset that) {
        return charset.compareTo(that);
    }

    /**
     * @see Charset#hashCode()
     * @since 2.6
     * @return the hash code.
     */
    @Override
    public int hashCode() {
        return charset.hashCode();
    }

    /**
     * @see Charset#equals(Object)
     * @since 2.6
     * @return true or false based on {@link Charset#equals(Object)}.
     */
    @Override
    public boolean equals(Object ob) {
        return charset.equals(ob);
    }

    /**
     * @see Charset#toString()
     * @since 2.6
     * @return the {@link String}
     */
    @Override
    public String toString() {
        return charset.toString();
    }

    @Override
    public void writeExternal(ObjectOutput out) throws IOException {
        out.writeUTF(charset.name());
    }

    @Override
    public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
        String name = in.readUTF();
        charset = Charset.forName(name);
    }

}