Top Description Fields Constructors Methods
org.apache.poi.ss.formula.ptg

public final Class BoolPtg

extends ScalarConstantPtg
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianInput, .LittleEndianOutput
Boolean (boolean) Stores a (java) boolean value in a formula.

Field Summary

Modifier and TypeField and Description
private final boolean
_value

private static final BoolPtg
FALSE

public static final byte
sid

public static final int
SIZE

private static final BoolPtg
TRUE

Constructor Summary

AccessConstructor and Description
private
BoolPtg(boolean b)

Method Summary

Modifier and TypeMethod and Description
public BoolPtg
copy()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.copy.

Implements org.apache.poi.common.Duplicatable.copy.

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public byte
getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

public int
getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

public boolean
getValue()

public static BoolPtg
read(LittleEndianInput in)

public String
toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

public static BoolPtg
valueOf(boolean b)

public void
write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.

Inherited from org.apache.poi.ss.formula.ptg.ScalarConstantPtg:
getDefaultOperandClassisBaseToken

Field Detail

_valueback to summary
private final boolean _value
FALSEback to summary
private static final BoolPtg FALSE
sidback to summary
public static final byte sid
SIZEback to summary
public static final int SIZE
TRUEback to summary
private static final BoolPtg TRUE

Constructor Detail

BoolPtgback to summary
private BoolPtg(boolean b)

Method Detail

copyback to summary
public BoolPtg copy()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:BoolPtg

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getSidback to summary
public byte getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

Returns:byte

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSid.

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

Annotations
@Override
getSizeback to summary
public int getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

Returns:int

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSize.

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

getValueback to summary
public boolean getValue()
readback to summary
public static BoolPtg read(LittleEndianInput in)
toFormulaStringback to summary
public String toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

Doc from org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

valueOfback to summary
public static BoolPtg valueOf(boolean b)
writeback to summary
public void write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.