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
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.
- Author:
- Nick Burch
-
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Grabs the count, from the first two bytes of the header.long
We are of type 4026getText()
Grabs the text.void
setOptions
(int count) Sets the count The meaning of the count is specific to the type of the parent recordvoid
Updates the text in the Atom.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 diskMethods 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
-
Constructor Details
-
CString
protected CString(byte[] source, int start, int len) For the CStrubg Atom -
CString
public CString()Create an empty CString
-
-
Method Details
-
getText
Grabs the text. Nevernull
-
setText
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 classRecord
-
writeOut
Write the contents of the record back, so it can be written to disk- Specified by:
writeOut
in classRecord
- Throws:
IOException
-
toString
Gets a string representation of this object, primarily for debugging.
-