123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179 |
- /* ====================================================================
- 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 org.apache.poi.ss.usermodel.ErrorConstants;
- import org.apache.poi.util.HexDump;
- import org.apache.poi.util.LittleEndianOutput;
-
- /**
- * Creates new BoolErrRecord. (0x0205) <P>
- * REFERENCE: PG ??? Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
- * @author Michael P. Harhen
- * @author Jason Height (jheight at chariot dot net dot au)
- */
- public final class BoolErrRecord extends CellRecord {
- public final static short sid = 0x0205;
- private int _value;
- /**
- * If <code>true</code>, this record represents an error cell value, otherwise this record represents a boolean cell value
- */
- private boolean _isError;
-
- /** Creates new BoolErrRecord */
- public BoolErrRecord() {
- // fields uninitialised
- }
-
- /**
- * @param in the RecordInputstream to read the record from
- */
- public BoolErrRecord(RecordInputStream in) {
- super(in);
- switch (in.remaining()) {
- case 2:
- _value = in.readByte();
- break;
- case 3:
- _value = in.readUShort();
- break;
- default:
- throw new RecordFormatException("Unexpected size ("
- + in.remaining() + ") for BOOLERR record.");
- }
- int flag = in.readUByte();
- switch (flag) {
- case 0:
- _isError = false;
- break;
- case 1:
- _isError = true;
- break;
- default:
- throw new RecordFormatException("Unexpected isError flag ("
- + flag + ") for BOOLERR record.");
- }
- }
-
- /**
- * set the boolean value for the cell
- *
- * @param value representing the boolean value
- */
- public void setValue(boolean value) {
- _value = value ? 1 : 0;
- _isError = false;
- }
-
- /**
- * set the error value for the cell
- *
- * @param value error representing the error value
- * this value can only be 0,7,15,23,29,36 or 42
- * see bugzilla bug 16560 for an explanation
- */
- public void setValue(byte value) {
- switch(value) {
- case ErrorConstants.ERROR_NULL:
- case ErrorConstants.ERROR_DIV_0:
- case ErrorConstants.ERROR_VALUE:
- case ErrorConstants.ERROR_REF:
- case ErrorConstants.ERROR_NAME:
- case ErrorConstants.ERROR_NUM:
- case ErrorConstants.ERROR_NA:
- _value = value;
- _isError = true;
- return;
- }
- throw new IllegalArgumentException("Error Value can only be 0,7,15,23,29,36 or 42. It cannot be "+value);
- }
-
- /**
- * get the value for the cell
- *
- * @return boolean representing the boolean value
- */
- public boolean getBooleanValue() {
- return _value != 0;
- }
-
- /**
- * get the error value for the cell
- *
- * @return byte representing the error value
- */
- public byte getErrorValue() {
- return (byte)_value;
- }
-
- /**
- * Indicates whether the call holds a boolean value
- *
- * @return boolean true if the cell holds a boolean value
- */
- public boolean isBoolean() {
- return !_isError;
- }
-
- /**
- * Indicates whether the call holds an error value
- *
- * @return boolean true if the cell holds an error value
- */
- public boolean isError() {
- return _isError;
- }
-
- @Override
- protected String getRecordName() {
- return "BOOLERR";
- }
- @Override
- protected void appendValueText(StringBuilder sb) {
- if (isBoolean()) {
- sb.append(" .boolVal = ");
- sb.append(getBooleanValue());
- } else {
- sb.append(" .errCode = ");
- sb.append(ErrorConstants.getText(getErrorValue()));
- sb.append(" (").append(HexDump.byteToHex(getErrorValue())).append(")");
- }
- }
- @Override
- protected void serializeValue(LittleEndianOutput out) {
- out.writeByte(_value);
- out.writeByte(_isError ? 1 : 0);
- }
-
- @Override
- protected int getValueDataSize() {
- return 2;
- }
-
- public short getSid() {
- return sid;
- }
-
- public Object clone() {
- BoolErrRecord rec = new BoolErrRecord();
- copyBaseFields(rec);
- rec._value = _value;
- rec._isError = _isError;
- return rec;
- }
- }
|