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

public final Class WriteAccessRecord

extends StandardRecord
Class Inheritance
Imports
java.nio.charset.Charset, .StandardCharsets, java.util.Arrays, .Map, java.util.function.Supplier, org.apache.poi.util.BitField, .BitFieldFactory, .GenericRecordUtil, .IOUtils, .LittleEndian, .LittleEndianOutput, .RecordFormatException, .StringUtil
Title: Write Access Record (0x005C)

Description: Stores the username of that who owns the spreadsheet generator (on unix the user's login, on Windoze its the name you typed when you installed the thing)

Field Summary

Modifier and TypeField and Description
private static final int
DATA_SIZE

private String
field_1_username

private static final byte
PAD_CHAR

private static final byte[]
PADDING

this record is always padded to a constant length

public static final short
sid

private static final int
STRING_SIZE

private static final BitField
UTF16FLAG

Constructor Summary

AccessConstructor and Description
public
WriteAccessRecord()

public
WriteAccessRecord(WriteAccessRecord other)

public
WriteAccessRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public WriteAccessRecord
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 short
getSid()

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

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

public String

Returns:

username of the user who is logged in (probably "tomcat" or "apache")
getUsername()

get the username for the user that created the report.

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
setUsername(String
of the user who is logged in (probably "tomcat" or "apache")
username)

set the username for the user that created the report.

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

Field Detail

DATA_SIZEback to summary
private static final int DATA_SIZE
field_1_usernameback to summary
private String field_1_username
PAD_CHARback to summary
private static final byte PAD_CHAR
PADDINGback to summary
private static final byte[] PADDING

this record is always padded to a constant length

sidback to summary
public static final short sid
STRING_SIZEback to summary
private static final int STRING_SIZE
UTF16FLAGback to summary
private static final BitField UTF16FLAG

Constructor Detail

WriteAccessRecordback to summary
public WriteAccessRecord()
WriteAccessRecordback to summary
public WriteAccessRecord(WriteAccessRecord other)
WriteAccessRecordback to summary
public WriteAccessRecord(RecordInputStream in)

Method Detail

copyback to summary
public WriteAccessRecord copy()

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

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

Returns:WriteAccessRecord

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.

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

Annotations
@Override
getUsernameback to summary
public String getUsername()

get the username for the user that created the report. HSSF uses the logged in user. On natively created M$ Excel sheet this would be the name you typed in when you installed it in most cases.

Returns:String

username of the user who is logged in (probably "tomcat" or "apache")

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

Annotations
@Override
setUsernameback to summary
public void setUsername(String username)

set the username for the user that created the report. HSSF uses the logged in user.

Parameters
username:String

of the user who is logged in (probably "tomcat" or "apache")