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

pack-priv final Class ArrayInitialPtg

extends Ptg
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.ss.formula.constant.ConstantValueParser, org.apache.poi.util.GenericRecordUtil, .LittleEndianInput, .LittleEndianOutput
Represents the initial plain tArray token (without the constant data that trails the whole formula). Objects of this class are only temporary and cannot be used as Ptgs. These temporary objects get converted to ArrayInitialPtg by the finishReading(LittleEndianInput) method.

Field Summary

Modifier and TypeField and Description
private final int
_reserved0

private final int
_reserved1

private final int
_reserved2

Inherited from org.apache.poi.ss.formula.ptg.Ptg:
CLASS_ARRAYCLASS_REFCLASS_VALUEEMPTY_PTG_ARRAY

Constructor Summary

AccessConstructor and Description
public
ArrayInitialPtg(LittleEndianInput in)

Method Summary

Modifier and TypeMethod and Description
public ArrayInitialPtg
copy()

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

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

public ArrayPtg
finishReading(LittleEndianInput in)

Read in the actual token (array) values.

public byte
getDefaultOperandClass()

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

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.

private static RuntimeException
invalid()

public boolean
isBaseToken()

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

public String
toFormulaString()

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

return a string representation of this token alone

public void
write(LittleEndianOutput out)

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

Inherited from org.apache.poi.ss.formula.ptg.Ptg:
createPtgdoesFormulaReferToDeletedCellgetEncodedSizegetEncodedSizeWithoutArrayDatagetPtgClassgetRVATypereadTokensserializePtgssetClasstoString

Field Detail

_reserved0back to summary
private final int _reserved0
_reserved1back to summary
private final int _reserved1
_reserved2back to summary
private final int _reserved2

Constructor Detail

ArrayInitialPtgback to summary
public ArrayInitialPtg(LittleEndianInput in)

Method Detail

copyback to summary
public ArrayInitialPtg copy()

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

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

Returns:ArrayInitialPtg

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

a deep copy of the implementing class / instance

Annotations
@Override
finishReadingback to summary
public ArrayPtg finishReading(LittleEndianInput in)

Read in the actual token (array) values. This occurs AFTER the last Ptg in the expression. See page 304-305 of Excel97-2007BinaryFileFormat(xls)Specification.pdf

getDefaultOperandClassback to summary
public byte getDefaultOperandClass()

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

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.

invalidback to summary
private static RuntimeException invalid()
isBaseTokenback to summary
public boolean isBaseToken()

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

Returns:boolean

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

false if this token is classified as 'reference', 'value', or 'array'

Annotations
@Override
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

writeback to summary
public void write(LittleEndianOutput out)

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