org.apache.poi.hssf.record.chart.ChartFRTInfoRecord Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi Show documentation
Apache POI - Java API To Access Microsoft Format Files
There is a newer version: 5.2.5
/* ====================================================================
   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.chart;

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

import org.apache.poi.hssf.record.HSSFRecordTypes;
import org.apache.poi.hssf.record.RecordInputStream;
import org.apache.poi.hssf.record.StandardRecord;
import org.apache.poi.util.GenericRecordUtil;
import org.apache.poi.util.LittleEndianInput;
import org.apache.poi.util.LittleEndianOutput;

/**
 * CHARTFRTINFO - Chart Future Record Type Info (0x0850)
 */
public final class ChartFRTInfoRecord extends StandardRecord {
    public static final short sid = 0x850;

    private final short rt;
    private final short grbitFrt;
    private final byte verOriginator;
    private final byte verWriter;
    private CFRTID[] rgCFRTID;

    private static final class CFRTID {
        public static final int ENCODED_SIZE = 4;
        private final int rtFirst;
        private final int rtLast;

        public CFRTID(CFRTID other) {
            rtFirst = other.rtFirst;
            rtLast = other.rtLast;
        }

        public CFRTID(LittleEndianInput in) {
            rtFirst = in.readShort();
            rtLast = in.readShort();
        }

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

    public ChartFRTInfoRecord(ChartFRTInfoRecord other) {
        super(other);
        rt = other.rt;
        grbitFrt = other.grbitFrt;
        verOriginator = other.verOriginator;
        verWriter = other.verWriter;
        if (other.rgCFRTID != null) {
            rgCFRTID = Stream.of(other.rgCFRTID).map(CFRTID::new).toArray(CFRTID[]::new);
        }
    }

    public ChartFRTInfoRecord(RecordInputStream in) {
        rt = in.readShort();
        grbitFrt = in.readShort();
        verOriginator = in.readByte();
        verWriter = in.readByte();
        int cCFRTID = in.readShort();
        if (cCFRTID < 0) {
            throw new IllegalArgumentException("Had negative CFRTID: " + cCFRTID);
        }

        rgCFRTID = new CFRTID[cCFRTID];
        for (int i = 0; i < cCFRTID; i++) {
            rgCFRTID[i] = new CFRTID(in);
        }
    }

    @Override
    protected int getDataSize() {
        return 2 + 2 + 1 + 1 + 2 + rgCFRTID.length * CFRTID.ENCODED_SIZE;
    }

    @Override
    public short getSid() {
        return sid;
    }

    @Override
    public void serialize(LittleEndianOutput out) {

        out.writeShort(rt);
        out.writeShort(grbitFrt);
        out.writeByte(verOriginator);
        out.writeByte(verWriter);
        out.writeShort(rgCFRTID.length);

        for (CFRTID cfrtid : rgCFRTID) {
            cfrtid.serialize(out);
        }
    }

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

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

    @Override
    public Map> getGenericProperties() {
        return GenericRecordUtil.getGenericProperties(
            "rt", () -> rt,
            "grbitFrt", () -> grbitFrt,
            "verOriginator", () -> verOriginator,
            "verWriter", () -> verWriter,
            "rgCFRTIDs", () -> rgCFRTID
        );
    }
}