org.apache.poi.hssf.record.cf.IconMultiStateThreshold 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.cf;

import org.apache.poi.util.LittleEndianInput;
import org.apache.poi.util.LittleEndianOutput;

/**
 * Icon / Multi-State specific Threshold / value (CFVO),
 *  for changes in Conditional Formatting
 */
public final class IconMultiStateThreshold extends Threshold implements Cloneable {
    /**
     * Cell values that are equal to the threshold value do not pass the threshold
     */
    public static final byte EQUALS_EXCLUDE = 0;
    /**
     * Cell values that are equal to the threshold value pass the threshold.
     */
    public static final byte EQUALS_INCLUDE = 1;
    
    private byte equals;

    public IconMultiStateThreshold() {
        super();
        equals = EQUALS_INCLUDE;
    }

    /** Creates new Ico Multi-State Threshold */
    public IconMultiStateThreshold(LittleEndianInput in) {
        super(in);
        equals = in.readByte();
        // Reserved, 4 bytes, all 0
        in.readInt();
    }

    public byte getEquals() {
        return equals;
    }
    public void setEquals(byte equals) {
        this.equals = equals;
    }

    public int getDataLength() {
        return super.getDataLength() + 5;
    }

    @Override
    public IconMultiStateThreshold clone() {
      IconMultiStateThreshold rec = new IconMultiStateThreshold();
      super.copyTo(rec);
      rec.equals = equals;
      return rec;
    }

    public void serialize(LittleEndianOutput out) {
        super.serialize(out);
        out.writeByte(equals);
        out.writeInt(0); // Reserved
    }
}