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

public final Class RefreshAllRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.BitField, .BitFieldFactory, .GenericRecordUtil, .LittleEndianOutput
Flag whether to refresh all external data when loading a sheet. (which hssf doesn't support anyhow so who really cares?)

Field Summary

Modifier and TypeField and Description
private int
_options

private static final BitField
refreshFlag

public static final short
sid

Constructor Summary

AccessConstructor and Description
private
RefreshAllRecord(int options)

private
RefreshAllRecord(RefreshAllRecord other)

public
RefreshAllRecord(RecordInputStream in)

public
RefreshAllRecord(boolean refreshAll)

Method Summary

Modifier and TypeMethod and Description
public RefreshAllRecord
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:

refreshall or not
getRefreshAll()

get whether to refresh all external data when loading a sheet

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
setRefreshAll(boolean
or not
refreshAll)

set whether to refresh all external data when loading a sheet

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

Field Detail

_optionsback to summary
private int _options
refreshFlagback to summary
private static final BitField refreshFlag
sidback to summary
public static final short sid

Constructor Detail

RefreshAllRecordback to summary
private RefreshAllRecord(int options)
RefreshAllRecordback to summary
private RefreshAllRecord(RefreshAllRecord other)
RefreshAllRecordback to summary
public RefreshAllRecord(RecordInputStream in)
RefreshAllRecordback to summary
public RefreshAllRecord(boolean refreshAll)

Method Detail

copyback to summary
public RefreshAllRecord copy()

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

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

Returns:RefreshAllRecord

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
getRefreshAllback to summary
public boolean getRefreshAll()

get whether to refresh all external data when loading a sheet

Returns:boolean

refreshall or not

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

setRefreshAllback to summary
public void setRefreshAll(boolean refreshAll)

set whether to refresh all external data when loading a sheet

Parameters
refreshAll:boolean

or not