From 711d4c8154a4f45305718a217a3c68959794cede Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Fri, 29 Jun 2007 14:48:00 +0000 Subject: [PATCH] Lots more javadoc warning fixes git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@551912 13f79535-47bb-0310-9956-ffa450edef68 --- .../poi/hssf/record/AbstractEscherHolderRecord.java | 6 +----- .../apache/poi/hssf/record/AreaFormatRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/AreaRecord.java | 5 +---- .../poi/hssf/record/AxisLineFormatRecord.java | 5 +---- .../apache/poi/hssf/record/AxisOptionsRecord.java | 5 +---- .../apache/poi/hssf/record/AxisParentRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/AxisRecord.java | 5 +---- .../org/apache/poi/hssf/record/AxisUsedRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/BOFRecord.java | 5 +---- .../org/apache/poi/hssf/record/BackupRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/BarRecord.java | 5 +---- .../org/apache/poi/hssf/record/BeginRecord.java | 5 +---- .../org/apache/poi/hssf/record/BlankRecord.java | 5 +---- .../org/apache/poi/hssf/record/BookBoolRecord.java | 5 +---- .../org/apache/poi/hssf/record/BoolErrRecord.java | 10 ++-------- .../apache/poi/hssf/record/BottomMarginRecord.java | 5 +---- .../apache/poi/hssf/record/BoundSheetRecord.java | 4 +--- .../org/apache/poi/hssf/record/CalcCountRecord.java | 5 +---- .../org/apache/poi/hssf/record/CalcModeRecord.java | 5 +---- .../poi/hssf/record/CategorySeriesAxisRecord.java | 5 +---- .../apache/poi/hssf/record/ChartFormatRecord.java | 5 +---- .../org/apache/poi/hssf/record/ChartRecord.java | 5 +---- .../org/apache/poi/hssf/record/CodepageRecord.java | 5 +---- .../apache/poi/hssf/record/ColumnInfoRecord.java | 5 +---- .../poi/hssf/record/CommonObjectDataSubRecord.java | 5 +---- .../org/apache/poi/hssf/record/ContinueRecord.java | 13 ++++--------- .../org/apache/poi/hssf/record/CountryRecord.java | 5 +---- .../org/apache/poi/hssf/record/DBCellRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/DSFRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/DatRecord.java | 5 +---- .../apache/poi/hssf/record/DataFormatRecord.java | 5 +---- .../poi/hssf/record/DateWindow1904Record.java | 5 +---- .../poi/hssf/record/DefaultColWidthRecord.java | 5 +---- .../DefaultDataLabelTextPropertiesRecord.java | 5 +---- .../poi/hssf/record/DefaultRowHeightRecord.java | 5 +---- .../org/apache/poi/hssf/record/DeltaRecord.java | 5 +---- .../apache/poi/hssf/record/DimensionsRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/EOFRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/EndRecord.java | 5 +---- .../org/apache/poi/hssf/record/EndSubRecord.java | 5 +---- .../org/apache/poi/hssf/record/ExtSSTRecord.java | 5 +---- .../poi/hssf/record/ExtendedFormatRecord.java | 5 +---- .../apache/poi/hssf/record/ExternSheetRecord.java | 5 +---- .../poi/hssf/record/ExternSheetSubRecord.java | 11 ++--------- .../org/apache/poi/hssf/record/FilePassRecord.java | 5 +---- .../apache/poi/hssf/record/FnGroupCountRecord.java | 5 +---- .../org/apache/poi/hssf/record/FontBasisRecord.java | 5 +---- .../org/apache/poi/hssf/record/FontIndexRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/FontRecord.java | 5 +---- .../org/apache/poi/hssf/record/FooterRecord.java | 5 +---- .../org/apache/poi/hssf/record/FormatRecord.java | 5 +---- .../org/apache/poi/hssf/record/FormulaRecord.java | 8 ++++---- .../org/apache/poi/hssf/record/FrameRecord.java | 5 +---- .../org/apache/poi/hssf/record/GridsetRecord.java | 5 +---- .../poi/hssf/record/GroupMarkerSubRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/GutsRecord.java | 5 +---- .../org/apache/poi/hssf/record/HCenterRecord.java | 5 +---- .../org/apache/poi/hssf/record/HeaderRecord.java | 5 +---- .../org/apache/poi/hssf/record/HideObjRecord.java | 5 +---- .../poi/hssf/record/HorizontalPageBreakRecord.java | 6 ++---- .../org/apache/poi/hssf/record/IndexRecord.java | 5 +---- .../apache/poi/hssf/record/InterfaceEndRecord.java | 5 +---- .../apache/poi/hssf/record/InterfaceHdrRecord.java | 5 +---- .../org/apache/poi/hssf/record/IterationRecord.java | 5 +---- .../org/apache/poi/hssf/record/LabelRecord.java | 10 ++-------- .../org/apache/poi/hssf/record/LabelSSTRecord.java | 5 +---- .../apache/poi/hssf/record/LeftMarginRecord.java | 7 ++----- .../org/apache/poi/hssf/record/LegendRecord.java | 5 +---- .../apache/poi/hssf/record/LineFormatRecord.java | 5 +---- .../apache/poi/hssf/record/LinkedDataRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/MMSRecord.java | 5 +---- .../apache/poi/hssf/record/MergeCellsRecord.java | 5 +---- .../org/apache/poi/hssf/record/MulBlankRecord.java | 9 ++------- .../org/apache/poi/hssf/record/MulRKRecord.java | 9 ++------- src/java/org/apache/poi/hssf/record/NameRecord.java | 13 +++---------- .../poi/hssf/record/NumberFormatIndexRecord.java | 5 +---- .../org/apache/poi/hssf/record/NumberRecord.java | 10 ++-------- src/java/org/apache/poi/hssf/record/ObjRecord.java | 5 +---- .../apache/poi/hssf/record/ObjectLinkRecord.java | 5 +---- .../org/apache/poi/hssf/record/PaletteRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/PaneRecord.java | 5 +---- .../org/apache/poi/hssf/record/PasswordRecord.java | 5 +---- .../apache/poi/hssf/record/PasswordRev4Record.java | 5 +---- .../org/apache/poi/hssf/record/PlotAreaRecord.java | 5 +---- .../apache/poi/hssf/record/PlotGrowthRecord.java | 5 +---- .../org/apache/poi/hssf/record/PrecisionRecord.java | 5 +---- .../poi/hssf/record/PrintGridlinesRecord.java | 5 +---- .../apache/poi/hssf/record/PrintHeadersRecord.java | 5 +---- .../apache/poi/hssf/record/PrintSetupRecord.java | 5 +---- .../org/apache/poi/hssf/record/ProtectRecord.java | 5 +---- .../poi/hssf/record/ProtectionRev4Record.java | 5 +---- src/java/org/apache/poi/hssf/record/RKRecord.java | 5 +---- .../org/apache/poi/hssf/record/RecalcIdRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/Record.java | 5 +---- .../org/apache/poi/hssf/record/RefModeRecord.java | 5 +---- .../apache/poi/hssf/record/RefreshAllRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/RowRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/SCLRecord.java | 5 +---- .../apache/poi/hssf/record/SaveRecalcRecord.java | 5 +---- .../org/apache/poi/hssf/record/SelectionRecord.java | 5 +---- .../hssf/record/SeriesChartGroupIndexRecord.java | 5 +---- .../apache/poi/hssf/record/SeriesIndexRecord.java | 5 +---- .../apache/poi/hssf/record/SeriesLabelsRecord.java | 5 +---- .../apache/poi/hssf/record/SeriesListRecord.java | 5 +---- .../org/apache/poi/hssf/record/SeriesRecord.java | 5 +---- .../apache/poi/hssf/record/SeriesTextRecord.java | 5 +---- .../poi/hssf/record/SeriesToChartGroupRecord.java | 5 +---- .../apache/poi/hssf/record/SharedFormulaRecord.java | 5 +---- .../poi/hssf/record/SheetPropertiesRecord.java | 5 +---- .../org/apache/poi/hssf/record/StringRecord.java | 9 ++------- .../org/apache/poi/hssf/record/StyleRecord.java | 5 +---- .../org/apache/poi/hssf/record/SupBookRecord.java | 9 ++------- .../org/apache/poi/hssf/record/TabIdRecord.java | 5 +---- .../poi/hssf/record/TextObjectBaseRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/TextRecord.java | 5 +---- src/java/org/apache/poi/hssf/record/TickRecord.java | 5 +---- .../org/apache/poi/hssf/record/UnicodeString.java | 11 ++--------- .../org/apache/poi/hssf/record/UnitsRecord.java | 6 +----- .../org/apache/poi/hssf/record/UnknownRecord.java | 6 +----- .../org/apache/poi/hssf/record/UseSelFSRecord.java | 5 +---- .../org/apache/poi/hssf/record/VCenterRecord.java | 5 +---- .../apache/poi/hssf/record/ValueRangeRecord.java | 5 +---- .../poi/hssf/record/VerticalPageBreakRecord.java | 4 +--- .../org/apache/poi/hssf/record/WSBoolRecord.java | 5 +---- .../org/apache/poi/hssf/record/WindowOneRecord.java | 5 +---- .../apache/poi/hssf/record/WindowProtectRecord.java | 5 +---- .../org/apache/poi/hssf/record/WindowTwoRecord.java | 5 +---- .../apache/poi/hssf/record/WriteAccessRecord.java | 5 +---- .../apache/poi/hssf/record/WriteProtectRecord.java | 5 +---- 129 files changed, 148 insertions(+), 563 deletions(-) diff --git a/src/java/org/apache/poi/hssf/record/AbstractEscherHolderRecord.java b/src/java/org/apache/poi/hssf/record/AbstractEscherHolderRecord.java index 184b078f84..42c8ea790d 100644 --- a/src/java/org/apache/poi/hssf/record/AbstractEscherHolderRecord.java +++ b/src/java/org/apache/poi/hssf/record/AbstractEscherHolderRecord.java @@ -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); diff --git a/src/java/org/apache/poi/hssf/record/AreaFormatRecord.java b/src/java/org/apache/poi/hssf/record/AreaFormatRecord.java index 6512ad1951..6482112e6f 100644 --- a/src/java/org/apache/poi/hssf/record/AreaFormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/AreaFormatRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/AreaRecord.java b/src/java/org/apache/poi/hssf/record/AreaRecord.java index 1feb89531f..32aa57eed2 100644 --- a/src/java/org/apache/poi/hssf/record/AreaRecord.java +++ b/src/java/org/apache/poi/hssf/record/AreaRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/AxisLineFormatRecord.java b/src/java/org/apache/poi/hssf/record/AxisLineFormatRecord.java index 6870aee949..e46ce1a5d2 100644 --- a/src/java/org/apache/poi/hssf/record/AxisLineFormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/AxisLineFormatRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/AxisOptionsRecord.java b/src/java/org/apache/poi/hssf/record/AxisOptionsRecord.java index 45d9fca72d..be359b80a8 100644 --- a/src/java/org/apache/poi/hssf/record/AxisOptionsRecord.java +++ b/src/java/org/apache/poi/hssf/record/AxisOptionsRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/AxisParentRecord.java b/src/java/org/apache/poi/hssf/record/AxisParentRecord.java index d143b20c01..3c4d598545 100644 --- a/src/java/org/apache/poi/hssf/record/AxisParentRecord.java +++ b/src/java/org/apache/poi/hssf/record/AxisParentRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/AxisRecord.java b/src/java/org/apache/poi/hssf/record/AxisRecord.java index d8335829af..b18c9c32fd 100644 --- a/src/java/org/apache/poi/hssf/record/AxisRecord.java +++ b/src/java/org/apache/poi/hssf/record/AxisRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/AxisUsedRecord.java b/src/java/org/apache/poi/hssf/record/AxisUsedRecord.java index 17ddaa753c..2b3937978a 100644 --- a/src/java/org/apache/poi/hssf/record/AxisUsedRecord.java +++ b/src/java/org/apache/poi/hssf/record/AxisUsedRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/BOFRecord.java b/src/java/org/apache/poi/hssf/record/BOFRecord.java index 6e54dd5b68..df532d036e 100644 --- a/src/java/org/apache/poi/hssf/record/BOFRecord.java +++ b/src/java/org/apache/poi/hssf/record/BOFRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/BackupRecord.java b/src/java/org/apache/poi/hssf/record/BackupRecord.java index 618fa35794..6ee6cccfb6 100644 --- a/src/java/org/apache/poi/hssf/record/BackupRecord.java +++ b/src/java/org/apache/poi/hssf/record/BackupRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/BarRecord.java b/src/java/org/apache/poi/hssf/record/BarRecord.java index 51e5064893..794247e3a4 100644 --- a/src/java/org/apache/poi/hssf/record/BarRecord.java +++ b/src/java/org/apache/poi/hssf/record/BarRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/BeginRecord.java b/src/java/org/apache/poi/hssf/record/BeginRecord.java index aef4a1a890..b899d3a6a8 100644 --- a/src/java/org/apache/poi/hssf/record/BeginRecord.java +++ b/src/java/org/apache/poi/hssf/record/BeginRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/BlankRecord.java b/src/java/org/apache/poi/hssf/record/BlankRecord.java index 2fd851789a..e4f0428761 100644 --- a/src/java/org/apache/poi/hssf/record/BlankRecord.java +++ b/src/java/org/apache/poi/hssf/record/BlankRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/BookBoolRecord.java b/src/java/org/apache/poi/hssf/record/BookBoolRecord.java index f7352a92cd..6b5cf98836 100644 --- a/src/java/org/apache/poi/hssf/record/BookBoolRecord.java +++ b/src/java/org/apache/poi/hssf/record/BookBoolRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/BoolErrRecord.java b/src/java/org/apache/poi/hssf/record/BoolErrRecord.java index 2902ddda45..28564224a9 100644 --- a/src/java/org/apache/poi/hssf/record/BoolErrRecord.java +++ b/src/java/org/apache/poi/hssf/record/BoolErrRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/BottomMarginRecord.java b/src/java/org/apache/poi/hssf/record/BottomMarginRecord.java index fe37666d3e..fc535e06b9 100644 --- a/src/java/org/apache/poi/hssf/record/BottomMarginRecord.java +++ b/src/java/org/apache/poi/hssf/record/BottomMarginRecord.java @@ -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 ) { diff --git a/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java b/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java index bf466e055e..bf264bf02a 100644 --- a/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java +++ b/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java @@ -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 ) diff --git a/src/java/org/apache/poi/hssf/record/CalcCountRecord.java b/src/java/org/apache/poi/hssf/record/CalcCountRecord.java index 0b78e5af88..307dfa35ee 100644 --- a/src/java/org/apache/poi/hssf/record/CalcCountRecord.java +++ b/src/java/org/apache/poi/hssf/record/CalcCountRecord.java @@ -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 * */ diff --git a/src/java/org/apache/poi/hssf/record/CalcModeRecord.java b/src/java/org/apache/poi/hssf/record/CalcModeRecord.java index 2d9e22a0cf..b36123638e 100644 --- a/src/java/org/apache/poi/hssf/record/CalcModeRecord.java +++ b/src/java/org/apache/poi/hssf/record/CalcModeRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/CategorySeriesAxisRecord.java b/src/java/org/apache/poi/hssf/record/CategorySeriesAxisRecord.java index 9d5c2c1863..7e38d6f6e6 100644 --- a/src/java/org/apache/poi/hssf/record/CategorySeriesAxisRecord.java +++ b/src/java/org/apache/poi/hssf/record/CategorySeriesAxisRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/ChartFormatRecord.java b/src/java/org/apache/poi/hssf/record/ChartFormatRecord.java index dbfa61fd1c..7a36914903 100644 --- a/src/java/org/apache/poi/hssf/record/ChartFormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/ChartFormatRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/ChartRecord.java b/src/java/org/apache/poi/hssf/record/ChartRecord.java index a75c1248d1..a4c6a5f4f4 100644 --- a/src/java/org/apache/poi/hssf/record/ChartRecord.java +++ b/src/java/org/apache/poi/hssf/record/ChartRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/CodepageRecord.java b/src/java/org/apache/poi/hssf/record/CodepageRecord.java index 659f975060..b2aa41039f 100644 --- a/src/java/org/apache/poi/hssf/record/CodepageRecord.java +++ b/src/java/org/apache/poi/hssf/record/CodepageRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java b/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java index e3db525ee6..932c4547a1 100644 --- a/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java +++ b/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/CommonObjectDataSubRecord.java b/src/java/org/apache/poi/hssf/record/CommonObjectDataSubRecord.java index cd3e6030e4..c4768ab0c7 100644 --- a/src/java/org/apache/poi/hssf/record/CommonObjectDataSubRecord.java +++ b/src/java/org/apache/poi/hssf/record/CommonObjectDataSubRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/ContinueRecord.java b/src/java/org/apache/poi/hssf/record/ContinueRecord.java index 53073a34e7..46d15a3c1e 100644 --- a/src/java/org/apache/poi/hssf/record/ContinueRecord.java +++ b/src/java/org/apache/poi/hssf/record/ContinueRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/CountryRecord.java b/src/java/org/apache/poi/hssf/record/CountryRecord.java index a4828851ce..ca1af5531c 100644 --- a/src/java/org/apache/poi/hssf/record/CountryRecord.java +++ b/src/java/org/apache/poi/hssf/record/CountryRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/DBCellRecord.java b/src/java/org/apache/poi/hssf/record/DBCellRecord.java index 7982626f20..caeb333a52 100644 --- a/src/java/org/apache/poi/hssf/record/DBCellRecord.java +++ b/src/java/org/apache/poi/hssf/record/DBCellRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/DSFRecord.java b/src/java/org/apache/poi/hssf/record/DSFRecord.java index 12e3de5d79..ea898c2f23 100644 --- a/src/java/org/apache/poi/hssf/record/DSFRecord.java +++ b/src/java/org/apache/poi/hssf/record/DSFRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/DatRecord.java b/src/java/org/apache/poi/hssf/record/DatRecord.java index 6a81e70960..1045996916 100644 --- a/src/java/org/apache/poi/hssf/record/DatRecord.java +++ b/src/java/org/apache/poi/hssf/record/DatRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/DataFormatRecord.java b/src/java/org/apache/poi/hssf/record/DataFormatRecord.java index fda03d4864..027e0c1afd 100644 --- a/src/java/org/apache/poi/hssf/record/DataFormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/DataFormatRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/DateWindow1904Record.java b/src/java/org/apache/poi/hssf/record/DateWindow1904Record.java index 9b9e37c2ca..3a692fd689 100644 --- a/src/java/org/apache/poi/hssf/record/DateWindow1904Record.java +++ b/src/java/org/apache/poi/hssf/record/DateWindow1904Record.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/DefaultColWidthRecord.java b/src/java/org/apache/poi/hssf/record/DefaultColWidthRecord.java index 0779fca828..6a38f4d2ba 100644 --- a/src/java/org/apache/poi/hssf/record/DefaultColWidthRecord.java +++ b/src/java/org/apache/poi/hssf/record/DefaultColWidthRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/DefaultDataLabelTextPropertiesRecord.java b/src/java/org/apache/poi/hssf/record/DefaultDataLabelTextPropertiesRecord.java index bda62c7601..771d7c4cf7 100644 --- a/src/java/org/apache/poi/hssf/record/DefaultDataLabelTextPropertiesRecord.java +++ b/src/java/org/apache/poi/hssf/record/DefaultDataLabelTextPropertiesRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/DefaultRowHeightRecord.java b/src/java/org/apache/poi/hssf/record/DefaultRowHeightRecord.java index 8cc76b7dc5..8f049c1602 100644 --- a/src/java/org/apache/poi/hssf/record/DefaultRowHeightRecord.java +++ b/src/java/org/apache/poi/hssf/record/DefaultRowHeightRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/DeltaRecord.java b/src/java/org/apache/poi/hssf/record/DeltaRecord.java index c768f80ba5..b7afe7486b 100644 --- a/src/java/org/apache/poi/hssf/record/DeltaRecord.java +++ b/src/java/org/apache/poi/hssf/record/DeltaRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/DimensionsRecord.java b/src/java/org/apache/poi/hssf/record/DimensionsRecord.java index 7489b0942a..feecd68653 100644 --- a/src/java/org/apache/poi/hssf/record/DimensionsRecord.java +++ b/src/java/org/apache/poi/hssf/record/DimensionsRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/EOFRecord.java b/src/java/org/apache/poi/hssf/record/EOFRecord.java index 720644edc0..0f6b87ad80 100644 --- a/src/java/org/apache/poi/hssf/record/EOFRecord.java +++ b/src/java/org/apache/poi/hssf/record/EOFRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/EndRecord.java b/src/java/org/apache/poi/hssf/record/EndRecord.java index 10ecc5b198..0c15e723f7 100644 --- a/src/java/org/apache/poi/hssf/record/EndRecord.java +++ b/src/java/org/apache/poi/hssf/record/EndRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/EndSubRecord.java b/src/java/org/apache/poi/hssf/record/EndSubRecord.java index 30501d1741..28478adbfa 100644 --- a/src/java/org/apache/poi/hssf/record/EndSubRecord.java +++ b/src/java/org/apache/poi/hssf/record/EndSubRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java b/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java index 1c2ba4225f..cb31fb59b4 100644 --- a/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java +++ b/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java b/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java index 743fded8a9..221668cb49 100644 --- a/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/ExternSheetRecord.java b/src/java/org/apache/poi/hssf/record/ExternSheetRecord.java index 7e0caf87c2..95c4442b15 100644 --- a/src/java/org/apache/poi/hssf/record/ExternSheetRecord.java +++ b/src/java/org/apache/poi/hssf/record/ExternSheetRecord.java @@ -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) { diff --git a/src/java/org/apache/poi/hssf/record/ExternSheetSubRecord.java b/src/java/org/apache/poi/hssf/record/ExternSheetSubRecord.java index 094c44aa60..184895d35f 100644 --- a/src/java/org/apache/poi/hssf/record/ExternSheetSubRecord.java +++ b/src/java/org/apache/poi/hssf/record/ExternSheetSubRecord.java @@ -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(); diff --git a/src/java/org/apache/poi/hssf/record/FilePassRecord.java b/src/java/org/apache/poi/hssf/record/FilePassRecord.java index 16e7325902..a3f29c7654 100644 --- a/src/java/org/apache/poi/hssf/record/FilePassRecord.java +++ b/src/java/org/apache/poi/hssf/record/FilePassRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/FnGroupCountRecord.java b/src/java/org/apache/poi/hssf/record/FnGroupCountRecord.java index b6c0604524..41bb07d8f4 100644 --- a/src/java/org/apache/poi/hssf/record/FnGroupCountRecord.java +++ b/src/java/org/apache/poi/hssf/record/FnGroupCountRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/FontBasisRecord.java b/src/java/org/apache/poi/hssf/record/FontBasisRecord.java index dac1852a23..a2a45e23c1 100644 --- a/src/java/org/apache/poi/hssf/record/FontBasisRecord.java +++ b/src/java/org/apache/poi/hssf/record/FontBasisRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/FontIndexRecord.java b/src/java/org/apache/poi/hssf/record/FontIndexRecord.java index 9ae33a9e3f..12e2f66691 100644 --- a/src/java/org/apache/poi/hssf/record/FontIndexRecord.java +++ b/src/java/org/apache/poi/hssf/record/FontIndexRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/FontRecord.java b/src/java/org/apache/poi/hssf/record/FontRecord.java index efd56dda5d..35d365a679 100644 --- a/src/java/org/apache/poi/hssf/record/FontRecord.java +++ b/src/java/org/apache/poi/hssf/record/FontRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/FooterRecord.java b/src/java/org/apache/poi/hssf/record/FooterRecord.java index e864e19a15..6a1aa8624b 100644 --- a/src/java/org/apache/poi/hssf/record/FooterRecord.java +++ b/src/java/org/apache/poi/hssf/record/FooterRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/FormatRecord.java b/src/java/org/apache/poi/hssf/record/FormatRecord.java index 5fb84b40bc..d71c401f88 100644 --- a/src/java/org/apache/poi/hssf/record/FormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/FormatRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/FormulaRecord.java b/src/java/org/apache/poi/hssf/record/FormulaRecord.java index 601cdcad82..f864cc63ea 100644 --- a/src/java/org/apache/poi/hssf/record/FormulaRecord.java +++ b/src/java/org/apache/poi/hssf/record/FormulaRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/FrameRecord.java b/src/java/org/apache/poi/hssf/record/FrameRecord.java index bb583be3f2..19ef9e0c62 100644 --- a/src/java/org/apache/poi/hssf/record/FrameRecord.java +++ b/src/java/org/apache/poi/hssf/record/FrameRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/GridsetRecord.java b/src/java/org/apache/poi/hssf/record/GridsetRecord.java index ff9ce987ee..5f5896d5a1 100644 --- a/src/java/org/apache/poi/hssf/record/GridsetRecord.java +++ b/src/java/org/apache/poi/hssf/record/GridsetRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/GroupMarkerSubRecord.java b/src/java/org/apache/poi/hssf/record/GroupMarkerSubRecord.java index b40f8f019a..cba7544e93 100644 --- a/src/java/org/apache/poi/hssf/record/GroupMarkerSubRecord.java +++ b/src/java/org/apache/poi/hssf/record/GroupMarkerSubRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/GutsRecord.java b/src/java/org/apache/poi/hssf/record/GutsRecord.java index 6b74e66ce9..2dc5c4a6cc 100644 --- a/src/java/org/apache/poi/hssf/record/GutsRecord.java +++ b/src/java/org/apache/poi/hssf/record/GutsRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/HCenterRecord.java b/src/java/org/apache/poi/hssf/record/HCenterRecord.java index 1dfb6203c6..5232e17dea 100644 --- a/src/java/org/apache/poi/hssf/record/HCenterRecord.java +++ b/src/java/org/apache/poi/hssf/record/HCenterRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/HeaderRecord.java b/src/java/org/apache/poi/hssf/record/HeaderRecord.java index 19b5de2ffa..cd58437028 100644 --- a/src/java/org/apache/poi/hssf/record/HeaderRecord.java +++ b/src/java/org/apache/poi/hssf/record/HeaderRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/HideObjRecord.java b/src/java/org/apache/poi/hssf/record/HideObjRecord.java index 64b1850d78..1496720d4f 100644 --- a/src/java/org/apache/poi/hssf/record/HideObjRecord.java +++ b/src/java/org/apache/poi/hssf/record/HideObjRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/HorizontalPageBreakRecord.java b/src/java/org/apache/poi/hssf/record/HorizontalPageBreakRecord.java index 95c18dfdc3..05b642a44d 100644 --- a/src/java/org/apache/poi/hssf/record/HorizontalPageBreakRecord.java +++ b/src/java/org/apache/poi/hssf/record/HorizontalPageBreakRecord.java @@ -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); diff --git a/src/java/org/apache/poi/hssf/record/IndexRecord.java b/src/java/org/apache/poi/hssf/record/IndexRecord.java index 654fc9aa2e..957a047eaa 100644 --- a/src/java/org/apache/poi/hssf/record/IndexRecord.java +++ b/src/java/org/apache/poi/hssf/record/IndexRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/InterfaceEndRecord.java b/src/java/org/apache/poi/hssf/record/InterfaceEndRecord.java index d96844a305..bb92c974ca 100644 --- a/src/java/org/apache/poi/hssf/record/InterfaceEndRecord.java +++ b/src/java/org/apache/poi/hssf/record/InterfaceEndRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/InterfaceHdrRecord.java b/src/java/org/apache/poi/hssf/record/InterfaceHdrRecord.java index 451c2e4bff..637e2c6794 100644 --- a/src/java/org/apache/poi/hssf/record/InterfaceHdrRecord.java +++ b/src/java/org/apache/poi/hssf/record/InterfaceHdrRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/IterationRecord.java b/src/java/org/apache/poi/hssf/record/IterationRecord.java index a4f917134c..16ab1d0741 100644 --- a/src/java/org/apache/poi/hssf/record/IterationRecord.java +++ b/src/java/org/apache/poi/hssf/record/IterationRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/LabelRecord.java b/src/java/org/apache/poi/hssf/record/LabelRecord.java index 52b3a48ee6..2dc2d940f4 100644 --- a/src/java/org/apache/poi/hssf/record/LabelRecord.java +++ b/src/java/org/apache/poi/hssf/record/LabelRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/LabelSSTRecord.java b/src/java/org/apache/poi/hssf/record/LabelSSTRecord.java index f87ceba32c..610f85522d 100644 --- a/src/java/org/apache/poi/hssf/record/LabelSSTRecord.java +++ b/src/java/org/apache/poi/hssf/record/LabelSSTRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/LeftMarginRecord.java b/src/java/org/apache/poi/hssf/record/LeftMarginRecord.java index 9f0b81902f..9e5883c5a0 100644 --- a/src/java/org/apache/poi/hssf/record/LeftMarginRecord.java +++ b/src/java/org/apache/poi/hssf/record/LeftMarginRecord.java @@ -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 \ No newline at end of file +} // END OF CLASS diff --git a/src/java/org/apache/poi/hssf/record/LegendRecord.java b/src/java/org/apache/poi/hssf/record/LegendRecord.java index 118fb0cf9e..40ddb887c2 100644 --- a/src/java/org/apache/poi/hssf/record/LegendRecord.java +++ b/src/java/org/apache/poi/hssf/record/LegendRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/LineFormatRecord.java b/src/java/org/apache/poi/hssf/record/LineFormatRecord.java index 2a8a4c88b6..5e359ab828 100644 --- a/src/java/org/apache/poi/hssf/record/LineFormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/LineFormatRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/LinkedDataRecord.java b/src/java/org/apache/poi/hssf/record/LinkedDataRecord.java index d334feaea9..46d52bf094 100644 --- a/src/java/org/apache/poi/hssf/record/LinkedDataRecord.java +++ b/src/java/org/apache/poi/hssf/record/LinkedDataRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/MMSRecord.java b/src/java/org/apache/poi/hssf/record/MMSRecord.java index 80cedbb05c..c38e9df244 100644 --- a/src/java/org/apache/poi/hssf/record/MMSRecord.java +++ b/src/java/org/apache/poi/hssf/record/MMSRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/MergeCellsRecord.java b/src/java/org/apache/poi/hssf/record/MergeCellsRecord.java index bbfd3e080c..41d8170dff 100644 --- a/src/java/org/apache/poi/hssf/record/MergeCellsRecord.java +++ b/src/java/org/apache/poi/hssf/record/MergeCellsRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/MulBlankRecord.java b/src/java/org/apache/poi/hssf/record/MulBlankRecord.java index 0f14b6fd48..b3ea117475 100644 --- a/src/java/org/apache/poi/hssf/record/MulBlankRecord.java +++ b/src/java/org/apache/poi/hssf/record/MulBlankRecord.java @@ -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 */ diff --git a/src/java/org/apache/poi/hssf/record/MulRKRecord.java b/src/java/org/apache/poi/hssf/record/MulRKRecord.java index 35a17bac3f..3aed6d00d5 100644 --- a/src/java/org/apache/poi/hssf/record/MulRKRecord.java +++ b/src/java/org/apache/poi/hssf/record/MulRKRecord.java @@ -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 */ diff --git a/src/java/org/apache/poi/hssf/record/NameRecord.java b/src/java/org/apache/poi/hssf/record/NameRecord.java index ae3470f7c4..97c9747cac 100644 --- a/src/java/org/apache/poi/hssf/record/NameRecord.java +++ b/src/java/org/apache/poi/hssf/record/NameRecord.java @@ -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(); diff --git a/src/java/org/apache/poi/hssf/record/NumberFormatIndexRecord.java b/src/java/org/apache/poi/hssf/record/NumberFormatIndexRecord.java index 2c8fe6bdbb..15f9c367d8 100644 --- a/src/java/org/apache/poi/hssf/record/NumberFormatIndexRecord.java +++ b/src/java/org/apache/poi/hssf/record/NumberFormatIndexRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/NumberRecord.java b/src/java/org/apache/poi/hssf/record/NumberRecord.java index f7f20d1eec..b21e488ed7 100644 --- a/src/java/org/apache/poi/hssf/record/NumberRecord.java +++ b/src/java/org/apache/poi/hssf/record/NumberRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/ObjRecord.java b/src/java/org/apache/poi/hssf/record/ObjRecord.java index 0dc48836fb..6583bd6777 100644 --- a/src/java/org/apache/poi/hssf/record/ObjRecord.java +++ b/src/java/org/apache/poi/hssf/record/ObjRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/ObjectLinkRecord.java b/src/java/org/apache/poi/hssf/record/ObjectLinkRecord.java index 5d0373515e..0d64ee3d6b 100644 --- a/src/java/org/apache/poi/hssf/record/ObjectLinkRecord.java +++ b/src/java/org/apache/poi/hssf/record/ObjectLinkRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/PaletteRecord.java b/src/java/org/apache/poi/hssf/record/PaletteRecord.java index 9dd7bc2ffd..d626baa2d3 100644 --- a/src/java/org/apache/poi/hssf/record/PaletteRecord.java +++ b/src/java/org/apache/poi/hssf/record/PaletteRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/PaneRecord.java b/src/java/org/apache/poi/hssf/record/PaneRecord.java index 795740289a..6f13ad0922 100644 --- a/src/java/org/apache/poi/hssf/record/PaneRecord.java +++ b/src/java/org/apache/poi/hssf/record/PaneRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/PasswordRecord.java b/src/java/org/apache/poi/hssf/record/PasswordRecord.java index 550a7ca7e9..13e8a43893 100644 --- a/src/java/org/apache/poi/hssf/record/PasswordRecord.java +++ b/src/java/org/apache/poi/hssf/record/PasswordRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/PasswordRev4Record.java b/src/java/org/apache/poi/hssf/record/PasswordRev4Record.java index 52e555dcea..8d31860af4 100644 --- a/src/java/org/apache/poi/hssf/record/PasswordRev4Record.java +++ b/src/java/org/apache/poi/hssf/record/PasswordRev4Record.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/PlotAreaRecord.java b/src/java/org/apache/poi/hssf/record/PlotAreaRecord.java index d371a3b1a1..e149c39ebb 100644 --- a/src/java/org/apache/poi/hssf/record/PlotAreaRecord.java +++ b/src/java/org/apache/poi/hssf/record/PlotAreaRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/PlotGrowthRecord.java b/src/java/org/apache/poi/hssf/record/PlotGrowthRecord.java index ad9f32ed6f..29c3259923 100644 --- a/src/java/org/apache/poi/hssf/record/PlotGrowthRecord.java +++ b/src/java/org/apache/poi/hssf/record/PlotGrowthRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/PrecisionRecord.java b/src/java/org/apache/poi/hssf/record/PrecisionRecord.java index ee1f3cc6cb..dd7b719221 100644 --- a/src/java/org/apache/poi/hssf/record/PrecisionRecord.java +++ b/src/java/org/apache/poi/hssf/record/PrecisionRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/PrintGridlinesRecord.java b/src/java/org/apache/poi/hssf/record/PrintGridlinesRecord.java index d8a4668b5c..ff0eaac18d 100644 --- a/src/java/org/apache/poi/hssf/record/PrintGridlinesRecord.java +++ b/src/java/org/apache/poi/hssf/record/PrintGridlinesRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/PrintHeadersRecord.java b/src/java/org/apache/poi/hssf/record/PrintHeadersRecord.java index 27536227f9..d3a69e5136 100644 --- a/src/java/org/apache/poi/hssf/record/PrintHeadersRecord.java +++ b/src/java/org/apache/poi/hssf/record/PrintHeadersRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/PrintSetupRecord.java b/src/java/org/apache/poi/hssf/record/PrintSetupRecord.java index 6fce4b4c28..874f304abd 100644 --- a/src/java/org/apache/poi/hssf/record/PrintSetupRecord.java +++ b/src/java/org/apache/poi/hssf/record/PrintSetupRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/ProtectRecord.java b/src/java/org/apache/poi/hssf/record/ProtectRecord.java index d768c11e5a..6d3ea06e69 100644 --- a/src/java/org/apache/poi/hssf/record/ProtectRecord.java +++ b/src/java/org/apache/poi/hssf/record/ProtectRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java b/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java index a5d81c2664..68678799dc 100644 --- a/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java +++ b/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/RKRecord.java b/src/java/org/apache/poi/hssf/record/RKRecord.java index 7e490edc4d..4d30ddf4c9 100644 --- a/src/java/org/apache/poi/hssf/record/RKRecord.java +++ b/src/java/org/apache/poi/hssf/record/RKRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/RecalcIdRecord.java b/src/java/org/apache/poi/hssf/record/RecalcIdRecord.java index 77e458b512..e076b2bab5 100644 --- a/src/java/org/apache/poi/hssf/record/RecalcIdRecord.java +++ b/src/java/org/apache/poi/hssf/record/RecalcIdRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/Record.java b/src/java/org/apache/poi/hssf/record/Record.java index 7d5a5d9690..133fe8d5ce 100644 --- a/src/java/org/apache/poi/hssf/record/Record.java +++ b/src/java/org/apache/poi/hssf/record/Record.java @@ -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()); diff --git a/src/java/org/apache/poi/hssf/record/RefModeRecord.java b/src/java/org/apache/poi/hssf/record/RefModeRecord.java index a783d4b069..c99d02e5c8 100644 --- a/src/java/org/apache/poi/hssf/record/RefModeRecord.java +++ b/src/java/org/apache/poi/hssf/record/RefModeRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/RefreshAllRecord.java b/src/java/org/apache/poi/hssf/record/RefreshAllRecord.java index 93af74f5e5..eae7a532ed 100644 --- a/src/java/org/apache/poi/hssf/record/RefreshAllRecord.java +++ b/src/java/org/apache/poi/hssf/record/RefreshAllRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/RowRecord.java b/src/java/org/apache/poi/hssf/record/RowRecord.java index 8533e7e040..a2815d2873 100644 --- a/src/java/org/apache/poi/hssf/record/RowRecord.java +++ b/src/java/org/apache/poi/hssf/record/RowRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/SCLRecord.java b/src/java/org/apache/poi/hssf/record/SCLRecord.java index 586ae761d4..f06694b865 100644 --- a/src/java/org/apache/poi/hssf/record/SCLRecord.java +++ b/src/java/org/apache/poi/hssf/record/SCLRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/SaveRecalcRecord.java b/src/java/org/apache/poi/hssf/record/SaveRecalcRecord.java index 169b7b2dd0..96ff53af24 100644 --- a/src/java/org/apache/poi/hssf/record/SaveRecalcRecord.java +++ b/src/java/org/apache/poi/hssf/record/SaveRecalcRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/SelectionRecord.java b/src/java/org/apache/poi/hssf/record/SelectionRecord.java index 81ba87ffe5..8ad4d0cefa 100644 --- a/src/java/org/apache/poi/hssf/record/SelectionRecord.java +++ b/src/java/org/apache/poi/hssf/record/SelectionRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/SeriesChartGroupIndexRecord.java b/src/java/org/apache/poi/hssf/record/SeriesChartGroupIndexRecord.java index 8372d585bd..076687d69f 100644 --- a/src/java/org/apache/poi/hssf/record/SeriesChartGroupIndexRecord.java +++ b/src/java/org/apache/poi/hssf/record/SeriesChartGroupIndexRecord.java @@ -45,10 +45,7 @@ public class SeriesChartGroupIndexRecord /** * Constructs a SeriesChartGroupIndex record and sets its fields appropriately. * - * @param id id must be 0x1045 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 SeriesChartGroupIndexRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/SeriesIndexRecord.java b/src/java/org/apache/poi/hssf/record/SeriesIndexRecord.java index a9781053a8..dcc2ebe4a3 100644 --- a/src/java/org/apache/poi/hssf/record/SeriesIndexRecord.java +++ b/src/java/org/apache/poi/hssf/record/SeriesIndexRecord.java @@ -45,10 +45,7 @@ public class SeriesIndexRecord /** * Constructs a SeriesIndex record and sets its fields appropriately. * - * @param id id must be 0x1065 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 SeriesIndexRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/SeriesLabelsRecord.java b/src/java/org/apache/poi/hssf/record/SeriesLabelsRecord.java index 1b042b579a..e2066b8b0b 100644 --- a/src/java/org/apache/poi/hssf/record/SeriesLabelsRecord.java +++ b/src/java/org/apache/poi/hssf/record/SeriesLabelsRecord.java @@ -51,10 +51,7 @@ public class SeriesLabelsRecord /** * Constructs a SeriesLabels record and sets its fields appropriately. * - * @param id id must be 0x100c 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 SeriesLabelsRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/SeriesListRecord.java b/src/java/org/apache/poi/hssf/record/SeriesListRecord.java index bd43ffe3fa..0825e68e6c 100644 --- a/src/java/org/apache/poi/hssf/record/SeriesListRecord.java +++ b/src/java/org/apache/poi/hssf/record/SeriesListRecord.java @@ -45,10 +45,7 @@ public class SeriesListRecord /** * Constructs a SeriesList record and sets its fields appropriately. * - * @param id id must be 0x1016 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 SeriesListRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/SeriesRecord.java b/src/java/org/apache/poi/hssf/record/SeriesRecord.java index 4bc40fb6ba..c13ff35e7c 100644 --- a/src/java/org/apache/poi/hssf/record/SeriesRecord.java +++ b/src/java/org/apache/poi/hssf/record/SeriesRecord.java @@ -62,10 +62,7 @@ public class SeriesRecord /** * Constructs a Series record and sets its fields appropriately. * - * @param id id must be 0x1003 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 SeriesRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/SeriesTextRecord.java b/src/java/org/apache/poi/hssf/record/SeriesTextRecord.java index f0e56d7943..1271ef8764 100644 --- a/src/java/org/apache/poi/hssf/record/SeriesTextRecord.java +++ b/src/java/org/apache/poi/hssf/record/SeriesTextRecord.java @@ -48,10 +48,7 @@ public class SeriesTextRecord /** * Constructs a SeriesText record and sets its fields appropriately. * - * @param id id must be 0x100d 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 SeriesTextRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/SeriesToChartGroupRecord.java b/src/java/org/apache/poi/hssf/record/SeriesToChartGroupRecord.java index c851f2a2b6..96e882e7c5 100644 --- a/src/java/org/apache/poi/hssf/record/SeriesToChartGroupRecord.java +++ b/src/java/org/apache/poi/hssf/record/SeriesToChartGroupRecord.java @@ -45,10 +45,7 @@ public class SeriesToChartGroupRecord /** * Constructs a SeriesToChartGroup record and sets its fields appropriately. * - * @param id id must be 0x1045 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 SeriesToChartGroupRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/SharedFormulaRecord.java b/src/java/org/apache/poi/hssf/record/SharedFormulaRecord.java index 75a5f2faba..c0f77cb558 100755 --- a/src/java/org/apache/poi/hssf/record/SharedFormulaRecord.java +++ b/src/java/org/apache/poi/hssf/record/SharedFormulaRecord.java @@ -55,10 +55,7 @@ public class SharedFormulaRecord } /** - * construct the sharedformula record, save all the information - * @param id id of the record -not validated, just stored for serialization - * @param size size of the data - * @param data the data + * @param in the RecordInputstream to read the record from */ public SharedFormulaRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/SheetPropertiesRecord.java b/src/java/org/apache/poi/hssf/record/SheetPropertiesRecord.java index 4b74e3a9a9..84fc3efc10 100644 --- a/src/java/org/apache/poi/hssf/record/SheetPropertiesRecord.java +++ b/src/java/org/apache/poi/hssf/record/SheetPropertiesRecord.java @@ -54,10 +54,7 @@ public class SheetPropertiesRecord /** * Constructs a SheetProperties record and sets its fields appropriately. * - * @param id id must be 0x1044 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 SheetPropertiesRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/StringRecord.java b/src/java/org/apache/poi/hssf/record/StringRecord.java index e35aa1f4d2..61e6975f13 100644 --- a/src/java/org/apache/poi/hssf/record/StringRecord.java +++ b/src/java/org/apache/poi/hssf/record/StringRecord.java @@ -43,9 +43,7 @@ public class StringRecord /** * Constructs a String 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 StringRecord(RecordInputStream in) { @@ -68,10 +66,7 @@ public class StringRecord } /** - * 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 * @param offset of the record's data (provided a big array of the file) */ diff --git a/src/java/org/apache/poi/hssf/record/StyleRecord.java b/src/java/org/apache/poi/hssf/record/StyleRecord.java index a80a95313e..9f45e3adf9 100644 --- a/src/java/org/apache/poi/hssf/record/StyleRecord.java +++ b/src/java/org/apache/poi/hssf/record/StyleRecord.java @@ -59,10 +59,7 @@ public class StyleRecord /** * Constructs a Style record and sets its fields appropriately. - * - * @param id id must be 0x293 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 StyleRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/SupBookRecord.java b/src/java/org/apache/poi/hssf/record/SupBookRecord.java index 79857ecb66..5d435194ef 100644 --- a/src/java/org/apache/poi/hssf/record/SupBookRecord.java +++ b/src/java/org/apache/poi/hssf/record/SupBookRecord.java @@ -45,9 +45,7 @@ public class SupBookRecord 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 SupBookRecord(RecordInputStream in) { @@ -63,10 +61,7 @@ public class SupBookRecord extends Record } /** - * 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 * @param offset of the record's data (provided a big array of the file) */ diff --git a/src/java/org/apache/poi/hssf/record/TabIdRecord.java b/src/java/org/apache/poi/hssf/record/TabIdRecord.java index 9b115b301c..7e924c3373 100644 --- a/src/java/org/apache/poi/hssf/record/TabIdRecord.java +++ b/src/java/org/apache/poi/hssf/record/TabIdRecord.java @@ -42,10 +42,7 @@ public class TabIdRecord /** * Constructs a TabID 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 TabIdRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/TextObjectBaseRecord.java b/src/java/org/apache/poi/hssf/record/TextObjectBaseRecord.java index c2192ff7af..4d3dbb43b1 100644 --- a/src/java/org/apache/poi/hssf/record/TextObjectBaseRecord.java +++ b/src/java/org/apache/poi/hssf/record/TextObjectBaseRecord.java @@ -72,10 +72,7 @@ public class TextObjectBaseRecord /** * Constructs a TextObjectBase record and sets its fields appropriately. * - * @param id id must be 0x1B6 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 TextObjectBaseRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/TextRecord.java b/src/java/org/apache/poi/hssf/record/TextRecord.java index c605def5ee..702dfbe163 100644 --- a/src/java/org/apache/poi/hssf/record/TextRecord.java +++ b/src/java/org/apache/poi/hssf/record/TextRecord.java @@ -95,10 +95,7 @@ public class TextRecord /** * Constructs a Text record and sets its fields appropriately. * - * @param id id must be 0x1025 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 TextRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/TickRecord.java b/src/java/org/apache/poi/hssf/record/TickRecord.java index 456c553af2..325dffc40c 100644 --- a/src/java/org/apache/poi/hssf/record/TickRecord.java +++ b/src/java/org/apache/poi/hssf/record/TickRecord.java @@ -60,10 +60,7 @@ public class TickRecord /** * Constructs a Tick record and sets its fields appropriately. * - * @param id id must be 0x101e 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 TickRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/UnicodeString.java b/src/java/org/apache/poi/hssf/record/UnicodeString.java index 1014cfc0a8..b53fcd485c 100644 --- a/src/java/org/apache/poi/hssf/record/UnicodeString.java +++ b/src/java/org/apache/poi/hssf/record/UnicodeString.java @@ -106,9 +106,7 @@ public class UnicodeString /** * construct a unicode string record and fill its fields, ID is ignored - * @param id - ignored - * @param size - size of the data - * @param data - the bytes of the string/fields + * @param in the RecordInputstream to read the record from */ public UnicodeString(RecordInputStream in) @@ -201,12 +199,7 @@ public class UnicodeString } /** - * 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) { diff --git a/src/java/org/apache/poi/hssf/record/UnitsRecord.java b/src/java/org/apache/poi/hssf/record/UnitsRecord.java index affa1ff162..a427a6c739 100644 --- a/src/java/org/apache/poi/hssf/record/UnitsRecord.java +++ b/src/java/org/apache/poi/hssf/record/UnitsRecord.java @@ -45,12 +45,8 @@ public class UnitsRecord /** * Constructs a Units record and sets its fields appropriately. * - * @param id id must be 0x1001 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 UnitsRecord(RecordInputStream in) { super(in); diff --git a/src/java/org/apache/poi/hssf/record/UnknownRecord.java b/src/java/org/apache/poi/hssf/record/UnknownRecord.java index d312931c83..f6770a613e 100644 --- a/src/java/org/apache/poi/hssf/record/UnknownRecord.java +++ b/src/java/org/apache/poi/hssf/record/UnknownRecord.java @@ -43,8 +43,6 @@ public class UnknownRecord } /** - * construct an unknown record. No fields are interperated and the record will - * be serialized in its original form more or less * @param id id of the record -not validated, just stored for serialization * @param data the data */ @@ -58,9 +56,7 @@ public class UnknownRecord /** * construct an unknown record. No fields are interperated and the record will * be serialized in its original form more or less - * @param id id of the record -not validated, just stored for serialization - * @param size size of the data - * @param data the data + * @param in the RecordInputstream to read the record from */ public UnknownRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/UseSelFSRecord.java b/src/java/org/apache/poi/hssf/record/UseSelFSRecord.java index 0d83beddec..107792eb3e 100644 --- a/src/java/org/apache/poi/hssf/record/UseSelFSRecord.java +++ b/src/java/org/apache/poi/hssf/record/UseSelFSRecord.java @@ -44,10 +44,7 @@ public class UseSelFSRecord /** * Constructs a UseSelFS record and sets its fields appropriately. - * - * @param id id must be 0x160 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 UseSelFSRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/VCenterRecord.java b/src/java/org/apache/poi/hssf/record/VCenterRecord.java index 0900ddfad4..e221b35f1c 100644 --- a/src/java/org/apache/poi/hssf/record/VCenterRecord.java +++ b/src/java/org/apache/poi/hssf/record/VCenterRecord.java @@ -42,10 +42,7 @@ public class VCenterRecord /** * Constructs a VCENTER 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 VCenterRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/ValueRangeRecord.java b/src/java/org/apache/poi/hssf/record/ValueRangeRecord.java index b697f308d2..44b26659e4 100644 --- a/src/java/org/apache/poi/hssf/record/ValueRangeRecord.java +++ b/src/java/org/apache/poi/hssf/record/ValueRangeRecord.java @@ -59,10 +59,7 @@ public class ValueRangeRecord /** * Constructs a ValueRange record and sets its fields appropriately. * - * @param id id must be 0x101f 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 ValueRangeRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/VerticalPageBreakRecord.java b/src/java/org/apache/poi/hssf/record/VerticalPageBreakRecord.java index 07ab693a24..6c715494f8 100644 --- a/src/java/org/apache/poi/hssf/record/VerticalPageBreakRecord.java +++ b/src/java/org/apache/poi/hssf/record/VerticalPageBreakRecord.java @@ -44,9 +44,7 @@ public class VerticalPageBreakRecord extends PageBreakRecord { } /** - * @param id - * @param size - * @param data + * @param in the RecordInputstream to read the record from */ public VerticalPageBreakRecord(RecordInputStream in) { super(in); diff --git a/src/java/org/apache/poi/hssf/record/WSBoolRecord.java b/src/java/org/apache/poi/hssf/record/WSBoolRecord.java index b5db02825b..480b7f240e 100644 --- a/src/java/org/apache/poi/hssf/record/WSBoolRecord.java +++ b/src/java/org/apache/poi/hssf/record/WSBoolRecord.java @@ -73,10 +73,7 @@ public class WSBoolRecord /** * Constructs a WSBool record and sets its fields appropriately. - * - * @param id id must be 0x81 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 WSBoolRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/WindowOneRecord.java b/src/java/org/apache/poi/hssf/record/WindowOneRecord.java index 4a141f14a0..f101cb59af 100644 --- a/src/java/org/apache/poi/hssf/record/WindowOneRecord.java +++ b/src/java/org/apache/poi/hssf/record/WindowOneRecord.java @@ -68,10 +68,7 @@ public class WindowOneRecord /** * Constructs a WindowOne record and sets its fields appropriately. - * - * @param id id must be 0x3d 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 WindowOneRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/WindowProtectRecord.java b/src/java/org/apache/poi/hssf/record/WindowProtectRecord.java index 17e876c171..9a5bc45dce 100644 --- a/src/java/org/apache/poi/hssf/record/WindowProtectRecord.java +++ b/src/java/org/apache/poi/hssf/record/WindowProtectRecord.java @@ -41,10 +41,7 @@ public class WindowProtectRecord /** * Constructs a WindowProtect record and sets its fields appropriately. - * - * @param id id must be 0x19 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 WindowProtectRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/WindowTwoRecord.java b/src/java/org/apache/poi/hssf/record/WindowTwoRecord.java index 3d010700e3..f6b51996d5 100644 --- a/src/java/org/apache/poi/hssf/record/WindowTwoRecord.java +++ b/src/java/org/apache/poi/hssf/record/WindowTwoRecord.java @@ -72,10 +72,7 @@ public class WindowTwoRecord /** * Constructs a WindowTwo record and sets its fields appropriately. - * - * @param id id must be 0x23e 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 WindowTwoRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/WriteAccessRecord.java b/src/java/org/apache/poi/hssf/record/WriteAccessRecord.java index 842d7529c8..af5f06e04f 100644 --- a/src/java/org/apache/poi/hssf/record/WriteAccessRecord.java +++ b/src/java/org/apache/poi/hssf/record/WriteAccessRecord.java @@ -44,10 +44,7 @@ public class WriteAccessRecord /** * Constructs a WriteAccess record and sets its fields appropriately. - * - * @param id id must be 0x5c 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 WriteAccessRecord(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/WriteProtectRecord.java b/src/java/org/apache/poi/hssf/record/WriteProtectRecord.java index 5d624f1bbf..9b3daf2a16 100644 --- a/src/java/org/apache/poi/hssf/record/WriteProtectRecord.java +++ b/src/java/org/apache/poi/hssf/record/WriteProtectRecord.java @@ -40,10 +40,7 @@ public class WriteProtectRecord /** * Constructs a WriteAccess record and sets its fields appropriately. - * - * @param id id must be 0x5c 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 WriteProtectRecord(RecordInputStream in) -- 2.39.5