org.apache.poi.hssf.record.formula
Class StringPtg

java.lang.Object
  extended by org.apache.poi.hssf.record.formula.Ptg
      extended by org.apache.poi.hssf.record.formula.StringPtg
All Implemented Interfaces:
java.lang.Cloneable

public final class StringPtg
extends Ptg

String Stores a String value in a formula value stored in the format <length 2 bytes>char[]

Author:
Werner Froidevaux, Jason Height (jheight at chariot dot net dot au), Bernard Chesnoy

Field Summary
static byte sid
           
static int SIZE
           
 
Fields inherited from class org.apache.poi.hssf.record.formula.Ptg
CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY
 
Constructor Summary
StringPtg(RecordInputStream in)
          Create a StringPtg from a stream
StringPtg(java.lang.String value)
          Create a StringPtg from a string representation of the number Number format is not checked, it is expected to be validated in the parser that calls this method.
 
Method Summary
 byte getDefaultOperandClass()
           
 int getSize()
           
 java.lang.String getValue()
           
 boolean isBaseToken()
           
 java.lang.String toFormulaString()
          return a string representation of this token alone
 java.lang.String toString()
          Overridden toString method to ensure object hash is not printed.
 void writeBytes(byte[] array, int offset)
          write this Ptg to a byte array
 
Methods inherited from class org.apache.poi.hssf.record.formula.Ptg
clone, copy, createPtg, getBytes, getEncodedSize, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, serializePtgs, setClass, toDebugString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SIZE

public static final int SIZE
See Also:
Constant Field Values

sid

public static final byte sid
See Also:
Constant Field Values
Constructor Detail

StringPtg

public StringPtg(RecordInputStream in)
Create a StringPtg from a stream


StringPtg

public StringPtg(java.lang.String value)
Create a StringPtg from a string representation of the number Number format is not checked, it is expected to be validated in the parser that calls this method.

Parameters:
value - : String representation of a floating point number
Method Detail

getValue

public java.lang.String getValue()

writeBytes

public void writeBytes(byte[] array,
                       int offset)
Description copied from class: Ptg
write this Ptg to a byte array

Specified by:
writeBytes in class Ptg

getSize

public int getSize()
Specified by:
getSize in class Ptg
Returns:
the encoded length of this Ptg, including the initial Ptg type identifier byte.

toFormulaString

public java.lang.String toFormulaString()
Description copied from class: Ptg
return a string representation of this token alone

Specified by:
toFormulaString in class Ptg

isBaseToken

public boolean isBaseToken()
Specified by:
isBaseToken in class Ptg
Returns:
false if this token is classified as 'reference', 'value', or 'array'

getDefaultOperandClass

public final byte getDefaultOperandClass()
Specified by:
getDefaultOperandClass in class Ptg

toString

public final java.lang.String toString()
Description copied from class: Ptg
Overridden toString method to ensure object hash is not printed. This helps get rid of gratuitous diffs when comparing two dumps Subclasses may output more relevant information by overriding this method

Overrides:
toString in class Ptg


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.