Package 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 Description CString()Create an empty CString
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetOptions()Grabs the count, from the first two bytes of the header.longgetRecordType()We are of type 4026java.lang.StringgetText()Grabs the text.voidsetOptions(int count)Sets the count The meaning of the count is specific to the type of the parent recordvoidsetText(java.lang.String text)Updates the text in the Atom.java.lang.StringtoString()Gets a string representation of this object, primarily for debugging.voidwriteOut(java.io.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
-
-
-
-
Method Detail
-
getText
public java.lang.String getText()
Grabs the text. Nevernull
-
setText
public void setText(java.lang.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:
getRecordTypein classRecord
-
writeOut
public void writeOut(java.io.OutputStream out) throws java.io.IOExceptionWrite the contents of the record back, so it can be written to disk
-
toString
public java.lang.String toString()
Gets a string representation of this object, primarily for debugging.- Overrides:
toStringin classjava.lang.Object- Returns:
- a string representation of this object.
-
-