Lots more javadoc warning fixes

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@551912 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2007-06-29 14:48:00 +00:00
parent aaf2c3119e
commit 63ca62be36
129 changed files with 148 additions and 563 deletions

View File

@ -52,12 +52,8 @@ public abstract class AbstractEscherHolderRecord
/**
* Constructs a Bar record and sets its fields appropriately.
*
* @param id id must be 0x1017 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 AbstractEscherHolderRecord(RecordInputStream in)
{
super(in);

View File

@ -52,10 +52,7 @@ public class AreaFormatRecord
/**
* Constructs a AreaFormat record and sets its fields appropriately.
*
* @param id id must be 0x100a 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 AreaFormatRecord(RecordInputStream in)

View File

@ -48,10 +48,7 @@ public class AreaRecord
/**
* Constructs a Area record and sets its fields appropriately.
*
* @param id id must be 0x101A 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 AreaRecord(RecordInputStream in)

View File

@ -49,10 +49,7 @@ public class AxisLineFormatRecord
/**
* Constructs a AxisLineFormat record and sets its fields appropriately.
*
* @param id id must be 0x1021 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 AxisLineFormatRecord(RecordInputStream in)

View File

@ -61,10 +61,7 @@ public class AxisOptionsRecord
/**
* Constructs a AxisOptions record and sets its fields appropriately.
*
* @param id id must be 0x1062 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 AxisOptionsRecord(RecordInputStream in)

View File

@ -51,10 +51,7 @@ public class AxisParentRecord
/**
* Constructs a AxisParent record and sets its fields appropriately.
*
* @param id id must be 0x1041 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 AxisParentRecord(RecordInputStream in)

View File

@ -52,10 +52,7 @@ public class AxisRecord
/**
* Constructs a Axis record and sets its fields appropriately.
*
* @param id id must be 0x101d 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 AxisRecord(RecordInputStream in)

View File

@ -45,10 +45,7 @@ public class AxisUsedRecord
/**
* Constructs a AxisUsed record and sets its fields appropriately.
*
* @param id id must be 0x1046 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 AxisUsedRecord(RecordInputStream in)

View File

@ -88,10 +88,7 @@ public class BOFRecord
/**
* Constructs a BOFRecord and sets its fields appropriately
*
* @param id id must be 0x809 or an exception will be throw upon validation
* @param 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 BOFRecord(RecordInputStream in)

View File

@ -42,10 +42,7 @@ public class BackupRecord
/**
* Constructs a BackupRecord and sets its fields appropriately
*
* @param id id must be 0x40 or an exception will be throw upon validation
* @param 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 BackupRecord(RecordInputStream in)

View File

@ -51,10 +51,7 @@ public class BarRecord
/**
* Constructs a Bar record and sets its fields appropriately.
*
* @param id id must be 0x1017 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 BarRecord(RecordInputStream in)

View File

@ -41,10 +41,7 @@ public class BeginRecord
/**
* Constructs a BeginRecord record and sets its fields appropriately.
*
* @param id id must be 0x1033 or an exception will be throw upon validation
* @param 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 BeginRecord(RecordInputStream in)

View File

@ -53,10 +53,7 @@ public class BlankRecord
/**
* Constructs a BlankRecord and sets its fields appropriately
*
* @param id id must be 0x201 or an exception will be throw upon validation
* @param 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 BlankRecord(RecordInputStream in)

View File

@ -42,10 +42,7 @@ public class BookBoolRecord
/**
* Constructs a BookBoolRecord and sets its fields appropriately
*
* @param id id must be 0xDA or an exception will be throw upon validation
* @param 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 BookBoolRecord(RecordInputStream in)

View File

@ -55,9 +55,7 @@ public class BoolErrRecord
/**
* Constructs a BoolErr record and sets its fields appropriately.
*
* @param id id must be 0x205 or an exception will be throw upon validation
* @param 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 BoolErrRecord(RecordInputStream in)
@ -66,11 +64,7 @@ public class BoolErrRecord
}
/**
* 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 in the RecordInputstream to read the record from
*/
protected void fillFields(RecordInputStream in)

View File

@ -42,10 +42,7 @@ public class BottomMarginRecord
/**
* Constructs a BottomMargin record and sets its fields appropriately.
*
* @param id id must be 0x29 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 BottomMarginRecord( RecordInputStream in )
{

View File

@ -50,9 +50,7 @@ public class BoundSheetRecord
/**
* Constructs a BoundSheetRecord and sets its fields appropriately
*
* @param id id must be 0x85 or an exception will be throw upon validation
* @param 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 BoundSheetRecord( RecordInputStream in )

View File

@ -47,10 +47,7 @@ public class CalcCountRecord
/**
* Constructs a CalcCountRecord and sets its fields appropriately
*
* @param id id must be 0xC or an exception will be throw upon validation
* @param 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
*
*/

View File

@ -63,10 +63,7 @@ public class CalcModeRecord
/**
* Constructs a CalcModeRecord and sets its fields appropriately
*
* @param id id must be 0xD or an exception will be throw upon validation
* @param 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 CalcModeRecord(RecordInputStream in)

View File

@ -51,10 +51,7 @@ public class CategorySeriesAxisRecord
/**
* Constructs a CategorySeriesAxis record and sets its fields appropriately.
*
* @param id id must be 0x1020 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 CategorySeriesAxisRecord(RecordInputStream in)

View File

@ -50,10 +50,7 @@ public class ChartFormatRecord
/**
* Constructs a ChartFormatRecord record and sets its fields appropriately.
*
* @param id id must equal the sid or an exception will be throw upon validation
* @param 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 ChartFormatRecord(RecordInputStream in)

View File

@ -48,10 +48,7 @@ public class ChartRecord
/**
* Constructs a Chart record and sets its fields appropriately.
*
* @param id id must be 0x1002 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 ChartRecord(RecordInputStream in)

View File

@ -49,10 +49,7 @@ public class CodepageRecord
/**
* Constructs a CodepageRecord and sets its fields appropriately
*
* @param id id must be 0x42 or an exception will be throw upon validation
* @param 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 CodepageRecord(RecordInputStream in)

View File

@ -56,10 +56,7 @@ public class ColumnInfoRecord
/**
* Constructs a ColumnInfo record and sets its fields appropriately
*
* @param id id must be 0x7d or an exception will be throw upon validation
* @param 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 ColumnInfoRecord(RecordInputStream in)

View File

@ -85,10 +85,7 @@ public class CommonObjectDataSubRecord
/**
* Constructs a CommonObjectData record and sets its fields appropriately.
*
* @param id id must be 0x15 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 CommonObjectDataSubRecord(RecordInputStream in)

View File

@ -48,9 +48,7 @@ public class ContinueRecord
/**
* Main constructor -- kinda dummy because we don't validate or fill fields
*
* @param id record id
* @param size record size
* @param data raw data
* @param in the RecordInputstream to read the record from
*/
public ContinueRecord(RecordInputStream in)
@ -80,9 +78,8 @@ public class ContinueRecord
// "You're not supposed to serialize Continue records like this directly");
}
/**
* set the data for continuation
* @param data - a byte array containing all of the continued data
/*
* @param data raw data
*/
public void setData(byte [] data)
@ -139,9 +136,7 @@ public class ContinueRecord
/**
* Fill the fields. Only thing is, this record has no fields --
*
* @param ignored_parm1 Ignored
* @param ignored_parm2 Ignored
* @param ignored_parm3 Ignored
* @param in the RecordInputstream to read the record from
*/
protected void fillFields(RecordInputStream in)

View File

@ -46,10 +46,7 @@ public class CountryRecord
/**
* Constructs a CountryRecord and sets its fields appropriately
*
* @param id id must be 0x8c or an exception will be throw upon validation
* @param 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 CountryRecord(RecordInputStream in)

View File

@ -44,10 +44,7 @@ public class DBCellRecord
/**
* Constructs a DBCellRecord and sets its fields appropriately
*
* @param id id must be 0xd7 or an exception will be throw upon validation
* @param 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 DBCellRecord(RecordInputStream in)

View File

@ -42,10 +42,7 @@ public class DSFRecord
/**
* Constructs a DBCellRecord and sets its fields appropriately.
*
* @param id id must be 0x161 or an exception will be throw upon validation
* @param 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 DSFRecord(RecordInputStream in)

View File

@ -49,10 +49,7 @@ public class DatRecord
/**
* Constructs a Dat record and sets its fields appropriately.
*
* @param id id must be 0x1063 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 DatRecord(RecordInputStream in)

View File

@ -49,10 +49,7 @@ public class DataFormatRecord
/**
* Constructs a DataFormat record and sets its fields appropriately.
*
* @param id id must be 0x1006 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 DataFormatRecord(RecordInputStream in)

View File

@ -42,10 +42,7 @@ public class DateWindow1904Record
/**
* Constructs a DateWindow1904 record and sets its fields appropriately.
*
* @param id id must be 0x22 or an exception will be throw upon validation
* @param 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 DateWindow1904Record(RecordInputStream in)

View File

@ -43,10 +43,7 @@ public class DefaultColWidthRecord
/**
* Constructs a DefaultColumnWidth record and sets its fields appropriately.
*
* @param id id must be 0x55 or an exception will be throw upon validation
* @param 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 DefaultColWidthRecord(RecordInputStream in)

View File

@ -48,10 +48,7 @@ public class DefaultDataLabelTextPropertiesRecord
/**
* Constructs a DefaultDataLabelTextProperties record and sets its fields appropriately.
*
* @param id id must be 0x1024 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 DefaultDataLabelTextPropertiesRecord(RecordInputStream in)

View File

@ -44,10 +44,7 @@ public class DefaultRowHeightRecord
/**
* Constructs a DefaultRowHeight record and sets its fields appropriately.
*
* @param id id must be 0x225 or an exception will be throw upon validation
* @param 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 DefaultRowHeightRecord(RecordInputStream in)

View File

@ -46,10 +46,7 @@ public class DeltaRecord
/**
* Constructs a Delta record and sets its fields appropriately.
*
* @param id id must be 0x10 or an exception will be throw upon validation
* @param 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 DeltaRecord(RecordInputStream in)

View File

@ -47,10 +47,7 @@ public class DimensionsRecord
/**
* Constructs a Dimensions record and sets its fields appropriately.
*
* @param id id must be 0x200 or an exception will be throw upon validation
* @param 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 DimensionsRecord(RecordInputStream in)

View File

@ -43,10 +43,7 @@ public class EOFRecord
/**
* Constructs a EOFRecord record and sets its fields appropriately.
*
* @param id id must be 0x0A or an exception will be throw upon validation
* @param 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 EOFRecord(RecordInputStream in)

View File

@ -41,10 +41,7 @@ public class EndRecord
/**
* Constructs a EndRecord record and sets its fields appropriately.
*
* @param id id must be 0x1034 or an exception will be throw upon validation
* @param 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 EndRecord(RecordInputStream in)

View File

@ -44,10 +44,7 @@ public class EndSubRecord
/**
* Constructs a End record and sets its fields appropriately.
*
* @param id id must be 0x00 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 EndSubRecord(RecordInputStream in)

View File

@ -55,10 +55,7 @@ public class ExtSSTRecord
/**
* Constructs a EOFRecord record and sets its fields appropriately.
*
* @param id id must be 0xff or an exception will be throw upon validation
* @param 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 ExtSSTRecord(RecordInputStream in)

View File

@ -197,10 +197,7 @@ public class ExtendedFormatRecord
/**
* Constructs an ExtendedFormat record and sets its fields appropriately.
*
* @param id id must be 0xE0 or an exception will be throw upon validation
* @param 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 ExtendedFormatRecord(RecordInputStream in)

View File

@ -42,10 +42,7 @@ public class ExternSheetRecord extends Record {
/**
* Constructs a Extern Sheet record and sets its fields appropriately.
*
* @param id id must be 0x16 or an exception will be throw upon validation
* @param 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 ExternSheetRecord(RecordInputStream in) {

View File

@ -44,9 +44,7 @@ public class ExternSheetSubRecord extends Record {
/**
* Constructs a Extern Sheet Sub Record record and sets its fields appropriately.
*
* @param id id must be 0x18 or an exception will be throw upon validation
* @param 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 ExternSheetSubRecord(RecordInputStream in) {
super(in);
@ -106,12 +104,7 @@ public class ExternSheetSubRecord 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 void fillFields(RecordInputStream in) {
field_1_index_to_supbook = in.readShort();

View File

@ -42,10 +42,7 @@ public class FilePassRecord
/**
* Constructs a FILEPASS record and sets its fields appropriately.
*
* @param id id must be 0x84 or an exception will be throw upon validation
* @param 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 FilePassRecord(RecordInputStream in)

View File

@ -48,10 +48,7 @@ public class FnGroupCountRecord
/**
* Constructs a FnGroupCount record and sets its fields appropriately.
*
* @param id id must be 0x9c or an exception will be throw upon validation
* @param 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 FnGroupCountRecord(RecordInputStream in)

View File

@ -49,10 +49,7 @@ public class FontBasisRecord
/**
* Constructs a FontBasis record and sets its fields appropriately.
*
* @param id id must be 0x1060 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 FontBasisRecord(RecordInputStream in)

View File

@ -45,10 +45,7 @@ public class FontIndexRecord
/**
* Constructs a FontIndex record and sets its fields appropriately.
*
* @param id id must be 0x1026 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 FontIndexRecord(RecordInputStream in)

View File

@ -79,10 +79,7 @@ public class FontRecord
/**
* Constructs a Font record and sets its fields appropriately.
*
* @param id id must be 0x31 (NOT 0x231 see MSKB #Q184647 for an "explanation of
* this bug in the documentation) or an exception will be throw upon validation
* @param 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 FontRecord(RecordInputStream in)

View File

@ -47,10 +47,7 @@ public class FooterRecord
/**
* Constructs a FooterRecord record and sets its fields appropriately.
*
* @param id id must be 0x15 or an exception will be throw upon validation
* @param 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 FooterRecord(RecordInputStream in)

View File

@ -48,10 +48,7 @@ public class FormatRecord
/**
* Constructs a Format record and sets its fields appropriately.
*
* @param id id must be 0x41e or an exception will be throw upon validation
* @param 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 FormatRecord(RecordInputStream in)

View File

@ -77,11 +77,11 @@ public class FormulaRecord
/**
* Constructs a Formula record and sets its fields appropriately.
* Note - id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an
* "explanation of this bug in the documentation) or an exception
* will be throw upon validation
*
* @param id id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an "explanation of
* this bug in the documentation) or an exception will be throw upon validation
* @param 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 FormulaRecord(RecordInputStream in)

View File

@ -50,10 +50,7 @@ public class FrameRecord
/**
* Constructs a Frame record and sets its fields appropriately.
*
* @param id id must be 0x1032 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 FrameRecord(RecordInputStream in)

View File

@ -46,10 +46,7 @@ public class GridsetRecord
/**
* Constructs a GridSet record and sets its fields appropriately.
*
* @param id id must be 0x82 or an exception will be throw upon validation
* @param 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 GridsetRecord(RecordInputStream in)

View File

@ -44,10 +44,7 @@ public class GroupMarkerSubRecord
/**
* Constructs a group marker record and sets its fields appropriately.
*
* @param id id must be 0x00 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 GroupMarkerSubRecord(RecordInputStream in)

View File

@ -45,10 +45,7 @@ public class GutsRecord
/**
* Constructs a Guts record and sets its fields appropriately.
*
* @param id id must be 0x80 or an exception will be throw upon validation
* @param 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 GutsRecord(RecordInputStream in)

View File

@ -42,10 +42,7 @@ public class HCenterRecord
/**
* Constructs an HCenter record and sets its fields appropriately.
*
* @param id id must be 0x83 or an exception will be throw upon validation
* @param 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 HCenterRecord(RecordInputStream in)

View File

@ -47,10 +47,7 @@ public class HeaderRecord
/**
* Constructs an Header record and sets its fields appropriately.
*
* @param id id must be 0x14 or an exception will be throw upon validation
* @param 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 HeaderRecord(RecordInputStream in)

View File

@ -44,10 +44,7 @@ public class HideObjRecord
/**
* Constructs an HideObj record and sets its fields appropriately.
*
* @param id id must be 0x8d or an exception will be throw upon validation
* @param 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 HideObjRecord(RecordInputStream in)

View File

@ -43,10 +43,8 @@ public class HorizontalPageBreakRecord extends PageBreakRecord {
super(sid);
}
/**
* @param id
* @param size
* @param data
/**
* @param in the RecordInputstream to read the record from
*/
public HorizontalPageBreakRecord(RecordInputStream in) {
super(in);

View File

@ -50,10 +50,7 @@ public class IndexRecord
/**
* Constructs an Index record and sets its fields appropriately.
*
* @param id id must be 0x208 or an exception will be throw upon validation
* @param 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 IndexRecord(RecordInputStream in)

View File

@ -41,10 +41,7 @@ public class InterfaceEndRecord
/**
* Constructs an InterfaceEnd record and sets its fields appropriately.
*
* @param id id must be 0xe2 or an exception will be throw upon validation
* @param 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 InterfaceEndRecord(RecordInputStream in)

View File

@ -47,10 +47,7 @@ public class InterfaceHdrRecord
/**
* Constructs an Codepage record and sets its fields appropriately.
*
* @param id id must be 0xe1 or an exception will be throw upon validation
* @param 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 InterfaceHdrRecord(RecordInputStream in)

View File

@ -45,10 +45,7 @@ public class IterationRecord
/**
* Constructs an Iteration record and sets its fields appropriately.
*
* @param id id must be 0x11 or an exception will be throw upon validation
* @param 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 IterationRecord(RecordInputStream in)

View File

@ -56,9 +56,7 @@ public class LabelRecord
/**
* Constructs an Label record and sets its fields appropriately.
*
* @param id id must be 0x204 or an exception will be throw upon validation
* @param 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 LabelRecord(RecordInputStream in)
@ -82,11 +80,7 @@ public class LabelRecord
}
/**
* 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 in the RecordInputstream to read the record from
*/
protected void fillFields(RecordInputStream in)

View File

@ -48,10 +48,7 @@ public class LabelSSTRecord
/**
* Constructs an LabelSST record and sets its fields appropriately.
*
* @param id id must be 0xfd or an exception will be throw upon validation
* @param 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 LabelSSTRecord(RecordInputStream in)

View File

@ -34,10 +34,7 @@ public class LeftMarginRecord extends Record implements Margin
/**
* Constructs a LeftMargin record and sets its fields appropriately.
*
* @param id id must be 0x26 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 LeftMarginRecord(RecordInputStream in)
{ super(in); }
@ -109,4 +106,4 @@ public class LeftMarginRecord extends Record implements Margin
rec.field_1_margin = this.field_1_margin;
return rec;
}
} // END OF CLASS
} // END OF CLASS

View File

@ -66,10 +66,7 @@ public class LegendRecord
/**
* Constructs a Legend record and sets its fields appropriately.
*
* @param id id must be 0x1015 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 LegendRecord(RecordInputStream in)

View File

@ -65,10 +65,7 @@ public class LineFormatRecord
/**
* Constructs a LineFormat record and sets its fields appropriately.
*
* @param id id must be 0x1007 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 LineFormatRecord(RecordInputStream in)

View File

@ -58,10 +58,7 @@ public class LinkedDataRecord
/**
* Constructs a LinkedData record and sets its fields appropriately.
*
* @param id id must be 0x1051 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 LinkedDataRecord(RecordInputStream in)

View File

@ -43,10 +43,7 @@ public class MMSRecord
/**
* Constructs a MMS record and sets its fields appropriately.
*
* @param id id must be 0xc1 or an exception will be throw upon validation
* @param 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 MMSRecord(RecordInputStream in)

View File

@ -45,10 +45,7 @@ public class MergeCellsRecord
/**
* Constructs a MergedCellsRecord and sets its fields appropriately
*
* @param sid id must be 0xe5 or an exception will be throw upon validation
* @param 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 MergeCellsRecord(RecordInputStream in)

View File

@ -55,9 +55,7 @@ public class MulBlankRecord
/**
* Constructs a MulBlank record and sets its fields appropriately.
*
* @param id id must be 0xbe or an exception will be throw upon validation
* @param 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 MulBlankRecord(RecordInputStream in)
@ -119,10 +117,7 @@ public class MulBlankRecord
}
/**
* called by the constructor, should set class level fields. Should throw
* runtime exception for bad/icomplete data.
*
* @param data raw data
* @param in the RecordInputstream to read the record from
* @param size size of data
*/

View File

@ -55,9 +55,7 @@ public class MulRKRecord
/**
* Constructs a MulRK record and sets its fields appropriately.
*
* @param id id must be 0xbd or an exception will be throw upon validation
* @param 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 MulRKRecord(RecordInputStream in)
@ -122,10 +120,7 @@ public class MulRKRecord
}
/**
* called by the constructor, should set class level fields. Should throw
* runtime exception for bad/icomplete data.
*
* @param data raw data
* @param in the RecordInputstream to read the record from
* @param size size of data
*/

View File

@ -135,9 +135,7 @@ public class NameRecord extends Record {
/**
* Constructs a Name record and sets its fields appropriately.
*
* @param id id must be 0x18 or an exception will be throw upon validation
* @param 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 NameRecord(RecordInputStream in) {
super(in);
@ -493,10 +491,7 @@ public class NameRecord extends Record {
/**
* called by the class that is responsible for writing this sucker.
* Subclasses should implement this so that their data is passed back in a
* byte array.
*
* @param offset to begin writing at
* @param data byte array containing instance data
* @param in the RecordInputstream to read the record from
* @return number of bytes written
*/
public int serialize( int offset, byte[] data )
@ -709,9 +704,7 @@ public class NameRecord 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 void fillFields(RecordInputStream in) {
field_1_option_flag = in.readShort();

View File

@ -45,10 +45,7 @@ public class NumberFormatIndexRecord
/**
* Constructs a NumberFormatIndex record and sets its fields appropriately.
*
* @param id id must be 0x104e 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 NumberFormatIndexRecord(RecordInputStream in)

View File

@ -54,9 +54,7 @@ public class NumberRecord
/**
* Constructs a Number record and sets its fields appropriately.
*
* @param id id must be 0x203 or an exception will be throw upon validation
* @param 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 NumberRecord(RecordInputStream in)
@ -65,11 +63,7 @@ public class NumberRecord
}
/**
* 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 in the RecordInputstream to read the record from
*/
protected void fillFields(RecordInputStream in)

View File

@ -52,10 +52,7 @@ public class ObjRecord
/**
* Constructs a OBJ record and sets its fields appropriately.
*
* @param id id must be 0x5D 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 ObjRecord(RecordInputStream in)

View File

@ -52,10 +52,7 @@ public class ObjectLinkRecord
/**
* Constructs a ObjectLink record and sets its fields appropriately.
*
* @param id id must be 0x1027 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 ObjectLinkRecord(RecordInputStream in)

View File

@ -50,10 +50,7 @@ public class PaletteRecord
/**
* Constructs a PaletteRecord record and sets its fields appropriately.
*
* @param id id must be 0x92 or an exception will be throw upon validation
* @param 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 PaletteRecord(RecordInputStream in)

View File

@ -53,10 +53,7 @@ public class PaneRecord
/**
* Constructs a Pane record and sets its fields appropriately.
*
* @param id id must be 0x41 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 PaneRecord(RecordInputStream in)

View File

@ -41,10 +41,7 @@ public class PasswordRecord
/**
* Constructs a Password record and sets its fields appropriately.
*
* @param id id must be 0x13 or an exception will be throw upon validation
* @param 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 PasswordRecord(RecordInputStream in)

View File

@ -42,10 +42,7 @@ public class PasswordRev4Record
/**
* Constructs a PasswordRev4 (PROT4REVPASS) record and sets its fields appropriately.
*
* @param id id must be 0x1bc or an exception will be throw upon validation
* @param 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 PasswordRev4Record(RecordInputStream in)

View File

@ -44,10 +44,7 @@ public class PlotAreaRecord
/**
* Constructs a PlotArea record and sets its fields appropriately.
*
* @param id id must be 0x1035 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 PlotAreaRecord(RecordInputStream in)

View File

@ -46,10 +46,7 @@ public class PlotGrowthRecord
/**
* Constructs a PlotGrowth record and sets its fields appropriately.
*
* @param id id must be 0x1064 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 PlotGrowthRecord(RecordInputStream in)

View File

@ -42,10 +42,7 @@ public class PrecisionRecord
/**
* Constructs a Precision record and sets its fields appropriately.
*
* @param id id must be 0xe or an exception will be throw upon validation
* @param 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 PrecisionRecord(RecordInputStream in)

View File

@ -42,10 +42,7 @@ public class PrintGridlinesRecord
/**
* Constructs a PrintGridlines record and sets its fields appropriately.
*
* @param id id must be 0x2b or an exception will be throw upon validation
* @param 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 PrintGridlinesRecord(RecordInputStream in)

View File

@ -43,10 +43,7 @@ public class PrintHeadersRecord
/**
* Constructs a PrintHeaders record and sets its fields appropriately.
*
* @param id id must be 0x2a or an exception will be throw upon validation
* @param 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 PrintHeadersRecord(RecordInputStream in)

View File

@ -73,10 +73,7 @@ public class PrintSetupRecord
/**
* Constructs a PrintSetup (SETUP) record and sets its fields appropriately.
*
* @param id id must be 0xa1 or an exception will be throw upon validation
* @param 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 PrintSetupRecord(RecordInputStream in)

View File

@ -43,10 +43,7 @@ public class ProtectRecord
/**
* Constructs a Protect record and sets its fields appropriately.
*
* @param id id must be 0x12 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 ProtectRecord(RecordInputStream in)

View File

@ -42,10 +42,7 @@ public class ProtectionRev4Record
/**
* Constructs a ProtectionRev4 record and sets its fields appropriately.
*
* @param id id must be 0x1af or an exception will be throw upon validation
* @param 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 ProtectionRev4Record(RecordInputStream in)

View File

@ -60,10 +60,7 @@ public class RKRecord
/**
* Constructs a RK record and sets its fields appropriately.
*
* @param id id must be 0x27e or an exception will be throw upon validation
* @param 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 RKRecord(RecordInputStream in)

View File

@ -51,10 +51,7 @@ public class RecalcIdRecord
/**
* Constructs a RECALCID record and sets its fields appropriately.
*
* @param id id must be 0x13d or an exception will be throw upon validation
* @param 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 RecalcIdRecord(RecordInputStream in)

View File

@ -45,11 +45,8 @@ public abstract class Record
/**
* Constructor Record
*
* @param id record id
* @param size record size
* @param data raw data
* @param in the RecordInputstream to read the record from
*/
public Record(RecordInputStream in)
{
validateSid(in.getSid());

View File

@ -44,10 +44,7 @@ public class RefModeRecord
/**
* Constructs a RefMode record and sets its fields appropriately.
*
* @param id id must be 0xf or an exception will be throw upon validation
* @param 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 RefModeRecord(RecordInputStream in)

View File

@ -42,10 +42,7 @@ public class RefreshAllRecord
/**
* Constructs a RefreshAll record and sets its fields appropriately.
*
* @param id id must be 0x187 or an exception will be throw upon validation
* @param 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 RefreshAllRecord(RecordInputStream in)

View File

@ -68,10 +68,7 @@ public class RowRecord
/**
* Constructs a Row record and sets its fields appropriately.
*
* @param id id must be 0x208 or an exception will be throw upon validation
* @param 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 RowRecord(RecordInputStream in)

View File

@ -46,10 +46,7 @@ public class SCLRecord
/**
* Constructs a SCL record and sets its fields appropriately.
*
* @param id id must be 0xa0 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 SCLRecord(RecordInputStream in)

View File

@ -42,10 +42,7 @@ public class SaveRecalcRecord
/**
* Constructs an SaveRecalc record and sets its fields appropriately.
*
* @param id id must be 0x5f or an exception will be throw upon validation
* @param 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 SaveRecalcRecord(RecordInputStream in)

View File

@ -83,10 +83,7 @@ public class SelectionRecord
/**
* Constructs a Selection record and sets its fields appropriately.
*
* @param id id must be 0x1d or an exception will be throw upon validation
* @param 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 SelectionRecord(RecordInputStream in)

Some files were not shown because too many files have changed in this diff Show More