org.apache.poi.hssf.record.CodepageRecord Maven / Gradle / Ivy


/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You 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 org.apache.poi.hssf.record;

import java.util.Map;
import java.util.function.Supplier;

import org.apache.poi.util.CodePageUtil;
import org.apache.poi.util.GenericRecordUtil;
import org.apache.poi.util.LittleEndianOutput;

/**
 * The default characterset. for the workbook
 *
 * Use {@link CodePageUtil} to turn these values into Java code pages to encode/decode strings.
 *
 * @version 2.0-pre
 */

public final class CodepageRecord extends StandardRecord {
    public static final short sid = 0x42;

    /**
     * Excel 97+ (Biff 8) should always store strings as UTF-16LE or
     *  compressed versions of that. As such, this should always be
     *  0x4b0 = UTF_16, except for files coming from older versions.
     */
    public static final short CODEPAGE = ( short ) 0x4b0;

    private short field_1_codepage;

    public CodepageRecord() {}

    public CodepageRecord(CodepageRecord other) {
        super(other);
        field_1_codepage = other.field_1_codepage;
    }

    public CodepageRecord(RecordInputStream in) {
        field_1_codepage = in.readShort();
    }

    /**
     * set the codepage for this workbook
     *
     * @see #CODEPAGE
     * @param cp the codepage to set
     */

    public void setCodepage(short cp)
    {
        field_1_codepage = cp;
    }

    /**
     * get the codepage for this workbook
     *
     * @see #CODEPAGE
     * @return codepage - the codepage to set
     */

    public short getCodepage()
    {
        return field_1_codepage;
    }

    public void serialize(LittleEndianOutput out) {
        out.writeShort(getCodepage());
    }

    protected int getDataSize() {
        return 2;
    }

    public short getSid()
    {
        return sid;
    }

    @Override
    public CodepageRecord copy() {
        return new CodepageRecord(this);
    }

    @Override
    public HSSFRecordTypes getGenericRecordType() {
        return HSSFRecordTypes.CODEPAGE;
    }

    @Override
    public Map> getGenericProperties() {
        return GenericRecordUtil.getGenericProperties(
            "codepage", this::getCodepage
        );
    }
}