/**
* Populates this fields data from the byte array passed in.
- * @param data raw data
- * @param size size of data
- * @param offset of the record's data (provided a big array of the file)
- * @return the number of bytes read.
+ * @param in the RecordInputstream to read the record from
*/
int fillField(RecordInputStream in);
* called by the constructor, should set class level fields. Should throw
* runtime exception for bad/icomplete data.
*
- * @param data raw data
- * @param size size of data
- * @param offset of the record's data (provided a big array of the file)
+ * @param in the RecordInputstream to read the record from
*/
protected void fillFields(RecordInputStream in) {
field_2_REF_structures = new ArrayList();
/**
* @param in the RecordInputstream to read the record from
- * @param size size of data
*/
-
protected void fillFields(RecordInputStream in)
{
//field_1_row = LittleEndian.getShort(data, 0 + offset);
/**
* @param in the RecordInputstream to read the record from
- * @param size size of data
*/
-
protected void fillFields(RecordInputStream in)
{
//field_1_row = LittleEndian.getShort(data, 0 + offset);
/**
* called by the class that is responsible for writing this sucker.
* Subclasses should implement this so that their data is passed back in a
- * @param in the RecordInputstream to read the record from
+ * @param offset to begin writing at
+ * @param data byte array containing instance data
* @return number of bytes written
*/
public int serialize( int offset, byte[] data )
* Options flags.
*
* @return the options flag
- * @see NoteRecord.NOTE_VISIBLE
- * @see NoteRecord.NOTE_HIDDEN
+ * @see #NOTE_VISIBLE
+ * @see #NOTE_HIDDEN
*/
public short getFlags(){
return field_3_flags;
* <p>REFERENCE: Microsoft Excel SDK page 322 and 420</p>
*
* @see HorizontalPageBreakRecord
-<<<<<<< PageBreakRecord.java
- * @see VerticalPageBreakREcord
- *
- * REFERENCE: Microsoft Excel SDK page 322 and 420
-=======
* @see VerticalPageBreakRecord
- *
->>>>>>> 1.5
* @author Danny Mui (dmui at apache dot org)
*/
public class PageBreakRecord extends Record {
* called by the constructor, should set class level fields. Should throw
* runtime exception for bad/icomplete data.
*
- * @param data raw data
- * @param size size of data
- * @param offset of the record's data (provided a big array of the file)
+ * @param in the RecordInputstream to read the record from
*/
protected abstract void fillFields(RecordInputStream in);
*
* { 0x16, 0x00 } -0x16
*
- * @param len the length of the final string
+ * @param length the length of the final string
* @return the converted string
* @exception IllegalArgumentException if len is too large (i.e.,
* there is not enough data in string to create a String of that
/**
* Constructs an SST record and sets its fields appropriately.
*
- * @param id must be 0xfc or an exception will be throw upon
- * validation
- * @param size the size of the data area of the record
- * @param data of the record (should not contain sid/len)
+ * @param in the RecordInputstream to read the record from
*/
public SSTRecord( RecordInputStream in )
* associated data. The UnicodeString class can handle the byte[]
* vs short[] nature of the actual string data
*
- * @param data raw data
- * @param size size of the raw data
+ * @param in the RecordInputstream to read the record from
*/
protected void fillFields( RecordInputStream in )
/**
* @param in the RecordInputstream to read the record from
- * @param size size of data
- * @param offset of the record's data (provided a big array of the file)
*/
protected void fillFields( RecordInputStream in)
{
/**
* @param in the RecordInputstream to read the record from
- * @param size size of data
- * @param offset of the record's data (provided a big array of the file)
*/
protected void fillFields(RecordInputStream in)
{
/**
* Constructs a TopMargin record and sets its fields appropriately.
*
- * @param id id must be 0x28 or an exception
- * will be throw upon validation
- * @param size size the size of the data area of the record
- * @param data data of the record (should not contain sid/len)
+ * @param in the RecordInputstream to read the record from
*/
public TopMarginRecord( RecordInputStream in )
{ super( in ); }
}
}
+ /**
+ * @param in the RecordInputstream to read the record from
+ */
protected void fillFields( RecordInputStream in )
{
field_1_margin = in.readDouble();
rec.field_1_margin = this.field_1_margin;
return rec;
}
-} // END OF CLASS
\ No newline at end of file
+} // END OF CLASS
* called by the constructor, should set class level fields. Should throw
* runtime exception for bad/icomplete data.
*
- * @param data raw data
- * @param size size of data
- * @param offset of the records data (provided a big array of the file)
+ * @param in the RecordInputstream to read the record from
*/
protected void fillFields(RecordInputStream in)
}
/**
- * called by the constructor, should set class level fields. Should throw
- * runtime exception for bad/incomplete data.
- *
- * @param data raw data
- * @param size size of data
- * @param offset of the record's data (provided a big array of the file)
+ * You never fill an aggregate
*/
-
protected void fillFields(RecordInputStream in)
{
}
/**
- * called by the constructor, should set class level fields. Should throw
- * runtime exception for bad/icomplete data.
- *
- * @param data raw data
- * @param size size of data
- * @param offset of the record's data (provided a big array of the file)
+ * You never fill an aggregate
*/
-
protected void fillFields(RecordInputStream in)
{
}
/**
* Constructor. Create a new GreaterThanPtg.
- * @param data the byte array to have the PTG added to
- * @param offset the offset to the PTG to.
+ * @param in the RecordInputstream to read the record from
*/
public GreaterThanPtg(RecordInputStream in)
{
/**
* Constructor. Create a new LessThanPtg.
- * @param data the byte array to have the PTG added to
- * @param offset the offset to the PTG to.
+ * @param in the RecordInputstream to read the record from
*/
public LessThanPtg(RecordInputStream in)
{
*
* @param formatIndex The index of the format, eg from ExtendedFormatRecord.getFormatIndex
* @param formatString The format string
+ * @see #isInternalDateFormat(int,String)
*/
public static boolean isADateFormat(int formatIndex, String formatString) {
// First up, is this an internal date format?
/**
* Given a format ID this will check whether the format represents
* an internal excel date format or not.
- * @see isDateFormat(int,String)
+ * @see #isDateFormat(int,String)
*/
public static boolean isInternalDateFormat(int format) {
boolean retval =false;
/**
* set character-set to use.
- * @return character-set
* @see #ANSI_CHARSET
* @see #DEFAULT_CHARSET
* @see #SYMBOL_CHARSET
projects / poi.git / commitdiff