Package org.apache.poi.ss.formula.ptg

Class BoolPtg

java.lang.Object

org.apache.poi.ss.formula.ptg.Ptg

org.apache.poi.ss.formula.ptg.ScalarConstantPtg

org.apache.poi.ss.formula.ptg.BoolPtg

All Implemented Interfaces:

Serializable, Duplicatable, GenericRecord

public final class BoolPtg
extends ScalarConstantPtg

Boolean (boolean) Stores a (java) boolean value in a formula.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static byte	sid
static int	SIZE

Fields inherited from class org.apache.poi.ss.formula.ptg.Ptg

CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY

Method Summary

Modifier and Type	Method	Description
BoolPtg	copy()
Map<String,Supplier<?>>	getGenericProperties()
byte	getSid()
int	getSize(SpreadsheetVersion version)
boolean	getValue()
static BoolPtg	read(LittleEndianInput in)
String	toFormulaString()	return a string representation of this token alone
static BoolPtg	valueOf(boolean b)
void	write(LittleEndianOutput out, SpreadsheetVersion version)

Methods inherited from class org.apache.poi.ss.formula.ptg.ScalarConstantPtg

getDefaultOperandClass, isBaseToken

Methods inherited from class org.apache.poi.ss.formula.ptg.Ptg

createPtg, createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSize, getEncodedSizeWithoutArrayData, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, readTokens, serializePtgs, serializePtgs, setClass, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren, getGenericRecordType

Field Detail

SIZE

public static final int SIZE

See Also:

Constant Field Values

sid

public static final byte sid

See Also:

Constant Field Values

Method Detail

valueOf

public static BoolPtg valueOf(boolean b)

read

public static BoolPtg read(LittleEndianInput in)

getValue

public boolean getValue()

write

public void write(LittleEndianOutput out,
                  SpreadsheetVersion version)

Specified by:

write in class Ptg

getSid

public byte getSid()

Specified by:

getSid in class Ptg

Returns:

structure id of the parsed thing, or -1 if the record has no sid

getSize

public int getSize(SpreadsheetVersion version)

Specified by:

getSize in class Ptg

Returns:

the encoded length of this Ptg, including the initial Ptg type identifier byte.

toFormulaString

public String toFormulaString()

Description copied from class: Ptg

return a string representation of this token alone

Specified by:

toFormulaString in class Ptg

copy

public BoolPtg copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class Ptg

Returns:

a deep copy of the implementing class / instance

getGenericProperties

public Map<String,Supplier<?>> getGenericProperties()