UnicodeString (Bio-Formats API)

java.lang.Object
- loci.poi.hssf.record.UnicodeString

All Implemented Interfaces:

Comparable
```
public class UnicodeString
extends Object
implements Comparable
```
Title: Unicode String
Description: Unicode String record. We implement these as a record, although they are really just standard fields that are in several records. It is considered more desirable then repeating it in all of them.
REFERENCE: PG 264 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:

2.0-pre

Author:

Andrew C. Oliver, Marc Johnson (mjohnson at apache dot org), Glen Stampoultzis (glens at apache.org)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UnicodeString.FormatRun`
`static class`	`UnicodeString.UnicodeRecordStats` Returns the size of this record, given the ammount of record space remaining, it will also include the size of writing a continue record.

Field Summary

Fields
Modifier and Type	Field and Description
`private static BitField`	`extBit`
`private short`	`field_1_charCount`
`private byte`	`field_2_optionflags`
`private String`	`field_3_string`
`private List`	`field_4_format_runs`
`private byte[]`	`field_5_ext_rst`
`private static BitField`	`highByte`
`private static BitField`	`richText`
`static short`	`sid`

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`UnicodeString()`
	`UnicodeString(RecordInputStream in)` construct a unicode string record and fill its fields, ID is ignored
	`UnicodeString(String str)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addFormatRun(UnicodeString.FormatRun r)` Adds a font run to the formatted string.
`void`	`clearFormatting()`
`Object`	`clone()`
`int`	`compareTo(Object obj)`
`boolean`	`equals(Object o)` Our handling of equals is inconsistent with compareTo.
`protected void`	`fillFields(RecordInputStream in)`
`private int`	`findFormatRunAt(int characterPos)`
`Iterator`	`formatIterator()`
`short`	`getCharCount()` get the number of characters in the string
`String`	`getDebugInfo()` return a character representation of the fields of this record
`byte[]`	`getExtendedRst()`
`UnicodeString.FormatRun`	`getFormatRun(int index)`
`int`	`getFormatRunCount()`
`byte`	`getOptionFlags()` get the option flags which among other things return if this is a 16-bit or 8 bit string
`void`	`getRecordSize(UnicodeString.UnicodeRecordStats stats)`
`short`	`getSid()`
`String`	`getString()` get the actual string this contains as a java String object
`int`	`hashCode()`
`boolean`	`isExtendedText()`
`boolean`	`isRichText()`
`private boolean`	`isUncompressedUnicode()`
`void`	`removeFormatRun(UnicodeString.FormatRun r)`
`int`	`serialize(UnicodeString.UnicodeRecordStats stats, int offset, byte[] data)`
`void`	`setCharCount(short cc)` set the number of characters in the string
`void`	`setCompressedUnicode()`
`void`	`setExtendedRst(byte[] ext_rst)`
`void`	`setOptionFlags(byte of)` set the option flags which among other things return if this is a 16-bit or 8 bit string
`void`	`setString(String string)` set the actual string this contains
`void`	`setUncompressedUnicode()`
`String`	`toString()` unlike the real records we return the same as "getString()" rather than debug info
`protected void`	`validateSid(short id)` NO OP
`private int`	`writeContinueIfRequired(UnicodeString.UnicodeRecordStats stats, int requiredSize, int offset, byte[] data)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - sid
```
public static final short sid
```
    See Also:
    Constant Field Values
  - field_1_charCount
```
private short field_1_charCount
```
  - field_2_optionflags
```
private byte field_2_optionflags
```
  - field_3_string
```
private String field_3_string
```
  - field_4_format_runs
```
private List field_4_format_runs
```
  - field_5_ext_rst
```
private byte[] field_5_ext_rst
```
  - highByte
```
private static final BitField highByte
```
  - extBit
```
private static final BitField extBit
```
  - richText
```
private static final BitField richText
```
- Constructor Detail
  - UnicodeString
```
private UnicodeString()
```
  - UnicodeString
```
public UnicodeString(String str)
```
  - UnicodeString
```
public UnicodeString(RecordInputStream in)
```
    construct a unicode string record and fill its fields, ID is ignored
    
    Parameters:
    in - the RecordInputstream to read the record from
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Our handling of equals is inconsistent with compareTo. The trouble is because we don't truely understand rich text fields yet it's difficult to make a sound comparison.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    o - The object to compare.
    
    Returns:
    true if the object is actually equal.
  - validateSid
```
protected void validateSid(short id)
```
    NO OP
  - fillFields
```
protected void fillFields(RecordInputStream in)
```
    Parameters:
    in - the RecordInputstream to read the record from
  - getCharCount
```
public short getCharCount()
```
    get the number of characters in the string
    
    Returns:
    number of characters
  - setCharCount
```
public void setCharCount(short cc)
```
    set the number of characters in the string
    
    Parameters:
    cc - - number of characters
  - getOptionFlags
```
public byte getOptionFlags()
```
    get the option flags which among other things return if this is a 16-bit or 8 bit string
    
    Returns:
    optionflags bitmask
  - setOptionFlags
```
public void setOptionFlags(byte of)
```
    set the option flags which among other things return if this is a 16-bit or 8 bit string
    
    Parameters:
    of - optionflags bitmask
  - getString
```
public String getString()
```
    get the actual string this contains as a java String object
    
    Returns:
    String
  - setString
```
public void setString(String string)
```
    set the actual string this contains
    
    Parameters:
    string - the text
  - getFormatRunCount
```
public int getFormatRunCount()
```
  - getFormatRun
```
public UnicodeString.FormatRun getFormatRun(int index)
```
  - findFormatRunAt
```
private int findFormatRunAt(int characterPos)
```
  - addFormatRun
```
public void addFormatRun(UnicodeString.FormatRun r)
```
    Adds a font run to the formatted string. If a font run exists at the current charcter location, then it is replaced with the font run to be added.
  - formatIterator
```
public Iterator formatIterator()
```
  - removeFormatRun
```
public void removeFormatRun(UnicodeString.FormatRun r)
```
  - clearFormatting
```
public void clearFormatting()
```
  - getExtendedRst
```
public byte[] getExtendedRst()
```
  - setExtendedRst
```
public void setExtendedRst(byte[] ext_rst)
```
  - toString
```
public String toString()
```
    unlike the real records we return the same as "getString()" rather than debug info
    
    Overrides:
    
    toString in class Object
    
    Returns:
    String value of the record
    See Also:
    getDebugInfo()
  - getDebugInfo
```
public String getDebugInfo()
```
    return a character representation of the fields of this record
    
    Returns:
    String of output for biffviewer etc.
  - writeContinueIfRequired
```
private int writeContinueIfRequired(UnicodeString.UnicodeRecordStats stats,
                          int requiredSize,
                          int offset,
                          byte[] data)
```
  - serialize
```
public int serialize(UnicodeString.UnicodeRecordStats stats,
            int offset,
            byte[] data)
```
  - setCompressedUnicode
```
public void setCompressedUnicode()
```
  - setUncompressedUnicode
```
public void setUncompressedUnicode()
```
  - isUncompressedUnicode
```
private boolean isUncompressedUnicode()
```
  - getRecordSize
```
public void getRecordSize(UnicodeString.UnicodeRecordStats stats)
```
  - getSid
```
public short getSid()
```
  - compareTo
```
public int compareTo(Object obj)
```
    Specified by:
    
    compareTo in interface Comparable
  - isRichText
```
public boolean isRichText()
```
  - isExtendedText
```
public boolean isExtendedText()
```
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object

Class UnicodeString

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sid

field_1_charCount

field_2_optionflags

field_3_string

field_4_format_runs

field_5_ext_rst

highByte

extBit

richText

Constructor Detail

UnicodeString

UnicodeString

UnicodeString

Method Detail

hashCode

equals

validateSid

fillFields

getCharCount

setCharCount

getOptionFlags

setOptionFlags

getString

setString

getFormatRunCount

getFormatRun

findFormatRunAt

addFormatRun

formatIterator

removeFormatRun

clearFormatting

getExtendedRst

setExtendedRst

toString

getDebugInfo

writeContinueIfRequired

serialize

setCompressedUnicode

setUncompressedUnicode

isUncompressedUnicode

getRecordSize

getSid

compareTo

isRichText

isExtendedText

clone