Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class IterationRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.BitField, .BitFieldFactory, .GenericRecordUtil, .LittleEndianOutput
Tells whether to iterate over formula calculations or not. If a formula is dependent upon another formula's result. (odd feature for something that can only have 32 elements in a formula!)

Field Summary

Modifier and TypeField and Description
private int
_flags

private static final BitField
iterationOn

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
IterationRecord(IterationRecord other)

public
IterationRecord(boolean iterateOn)

public
IterationRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public IterationRecord
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

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

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

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

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

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public boolean

Returns:

whether iterative calculations are turned off or on
getIteration()

get whether or not to iterate for calculations

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
setIteration(boolean
or not
iterate)

set whether or not to iterate for calculations

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

_flagsback to summary
private int _flags
iterationOnback to summary
private static final BitField iterationOn
sidback to summary
public static final short sid

Constructor Detail

IterationRecordback to summary
public IterationRecord(IterationRecord other)
IterationRecordback to summary
public IterationRecord(boolean iterateOn)
IterationRecordback to summary
public IterationRecord(RecordInputStream in)

Method Detail

copyback to summary
public IterationRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

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

Returns:IterationRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

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

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

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getIterationback to summary
public boolean getIteration()

get whether or not to iterate for calculations

Returns:boolean

whether iterative calculations are turned off or on

getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

setIterationback to summary
public void setIteration(boolean iterate)

set whether or not to iterate for calculations

Parameters
iterate:boolean

or not