org.apache.poi.hslf.record

Class CString

java.lang.Object

org.apache.poi.hslf.record.Record

org.apache.poi.hslf.record.RecordAtom

org.apache.poi.hslf.record.CString

public final class CString
extends RecordAtom

A CString (type 4026). Holds a unicode string, and the first two bytes of the record header normally encode the count. Typically attached to some complex sequence of records, eg Commetns.

Constructor Summary

Constructors

Constructor and Description
CString() Create an empty CString

Method Summary

Modifier and Type	Method and Description
int	getOptions() Grabs the count, from the first two bytes of the header.
long	getRecordType() We are of type 4026
String	getText() Grabs the text.
void	setOptions(int count) Sets the count The meaning of the count is specific to the type of the parent record
void	setText(String text) Updates the text in the Atom.
String	toString() Gets a string representation of this object, primarily for debugging.
void	writeOut(OutputStream out) Write the contents of the record back, so it can be written to disk

Methods inherited from class org.apache.poi.hslf.record.RecordAtom

getChildRecords, isAnAtom

Methods inherited from class org.apache.poi.hslf.record.Record

buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CString

public CString()

Create an empty CString

Method Detail

getText

public String getText()

Grabs the text. Never null

setText

public void setText(String text)

Updates the text in the Atom.

getOptions

public int getOptions()

Grabs the count, from the first two bytes of the header. The meaning of the count is specific to the type of the parent record

setOptions

public void setOptions(int count)

Sets the count The meaning of the count is specific to the type of the parent record

getRecordType

public long getRecordType()

We are of type 4026

Specified by:

getRecordType in class Record

writeOut

public void writeOut(OutputStream out)
              throws IOException

Write the contents of the record back, so it can be written to disk

Specified by:

writeOut in class Record

Throws:

IOException

toString

public String toString()

Gets a string representation of this object, primarily for debugging.

Overrides:

toString in class Object

Returns:

a string representation of this object.