moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

fixing javadocs errors (in JDK8)

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1748054 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Andreas Beeker 2016-06-12 21:28:13 +00:00
parent a1ff5002a5
commit a696823927
33 changed files with 240 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/java/org/apache/poi/hpsf/PropertySet.java
View File

@ -52,7 +52,7 @@ import org.apache.poi.util.LittleEndian;
* convenience method {@link #getProperties} returns the properties of
* a {@link PropertySet}'s {@link Section} (throwing a {@link
* NoSingleSectionException} if the {@link PropertySet} contains more
* (or less) than exactly one {@link Section}).</p>
* (or less) than exactly one {@link Section}).
*/
public class PropertySet
{

6
src/java/org/apache/poi/hpsf/Thumbnail.java
View File

@ -22,8 +22,8 @@ import org.apache.poi.util.LittleEndian;
* <p>Class to manipulate data in the Clipboard Variant ({@link
* Variant#VT_CF VT_CF}) format.</p>
*
* @author Drew Varner (Drew.Varner inOrAround sc.edu)
* @see SummaryInformation#getThumbnail()
* @see <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms649014(v=vs.85).aspx">Clipboard Operations</a>
*/
public final class Thumbnail {
@ -116,10 +116,6 @@ public final class Thumbnail {
/**
* <p>Clipboard Format - Bitmap</p>
*
* <p>Obsolete, see <a
* href="msdn.microsoft.com/library/en-us/dnw98bk/html/clipboardoperations.asp
* target="_blank">msdn.microsoft.com/library/en-us/dnw98bk/html/clipboardoperations.asp</a>.</p>
*/
public static final int CF_BITMAP = 2;

2
src/java/org/apache/poi/hpsf/wellknown/PropertyIDMap.java
View File

@ -100,7 +100,7 @@ public class PropertyIDMap extends HashMap<Long,String> {
* document is allowed or whether is should be opened as read-only. It can
* have the following values:</p>
*
* <table>
* <table summary="">
* <tbody>
* <tr>
* <th><p>Value</p></th>

173
src/java/org/apache/poi/hssf/dev/BiffViewer.java
View File

@ -31,10 +31,159 @@ import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
import org.apache.poi.hssf.record.*;
import org.apache.poi.hssf.record.RecordFormatException;
import org.apache.poi.hssf.record.ArrayRecord;
import org.apache.poi.hssf.record.AutoFilterInfoRecord;
import org.apache.poi.hssf.record.BOFRecord;
import org.apache.poi.hssf.record.BackupRecord;
import org.apache.poi.hssf.record.BlankRecord;
import org.apache.poi.hssf.record.BookBoolRecord;
import org.apache.poi.hssf.record.BoolErrRecord;
import org.apache.poi.hssf.record.BottomMarginRecord;
import org.apache.poi.hssf.record.BoundSheetRecord;
import org.apache.poi.hssf.record.CFHeader12Record;
import org.apache.poi.hssf.record.CFHeaderRecord;
import org.apache.poi.hssf.record.CFRule12Record;
import org.apache.poi.hssf.record.CFRuleRecord;
import org.apache.poi.hssf.record.CalcCountRecord;
import org.apache.poi.hssf.record.CalcModeRecord;
import org.apache.poi.hssf.record.CodepageRecord;
import org.apache.poi.hssf.record.ColumnInfoRecord;
import org.apache.poi.hssf.record.ContinueRecord;
import org.apache.poi.hssf.record.CountryRecord;
import org.apache.poi.hssf.record.DBCellRecord;
import org.apache.poi.hssf.record.DConRefRecord;
import org.apache.poi.hssf.record.DSFRecord;
import org.apache.poi.hssf.record.DVALRecord;
import org.apache.poi.hssf.record.DVRecord;
import org.apache.poi.hssf.record.DateWindow1904Record;
import org.apache.poi.hssf.record.DefaultColWidthRecord;
import org.apache.poi.hssf.record.DefaultRowHeightRecord;
import org.apache.poi.hssf.record.DeltaRecord;
import org.apache.poi.hssf.record.DimensionsRecord;
import org.apache.poi.hssf.record.DrawingGroupRecord;
import org.apache.poi.hssf.record.DrawingRecordForBiffViewer;
import org.apache.poi.hssf.record.DrawingSelectionRecord;
import org.apache.poi.hssf.record.EOFRecord;
import org.apache.poi.hssf.record.ExtSSTRecord;
import org.apache.poi.hssf.record.ExtendedFormatRecord;
import org.apache.poi.hssf.record.ExternSheetRecord;
import org.apache.poi.hssf.record.ExternalNameRecord;
import org.apache.poi.hssf.record.FeatHdrRecord;
import org.apache.poi.hssf.record.FeatRecord;
import org.apache.poi.hssf.record.FilePassRecord;
import org.apache.poi.hssf.record.FileSharingRecord;
import org.apache.poi.hssf.record.FnGroupCountRecord;
import org.apache.poi.hssf.record.FontRecord;
import org.apache.poi.hssf.record.FooterRecord;
import org.apache.poi.hssf.record.FormatRecord;
import org.apache.poi.hssf.record.FormulaRecord;
import org.apache.poi.hssf.record.GridsetRecord;
import org.apache.poi.hssf.record.GutsRecord;
import org.apache.poi.hssf.record.HCenterRecord;
import org.apache.poi.hssf.record.HeaderRecord;
import org.apache.poi.hssf.record.HideObjRecord;
import org.apache.poi.hssf.record.HorizontalPageBreakRecord;
import org.apache.poi.hssf.record.HyperlinkRecord;
import org.apache.poi.hssf.record.IndexRecord;
import org.apache.poi.hssf.record.InterfaceEndRecord;
import org.apache.poi.hssf.record.InterfaceHdrRecord;
import org.apache.poi.hssf.record.IterationRecord;
import org.apache.poi.hssf.record.LabelRecord;
import org.apache.poi.hssf.record.LabelSSTRecord;
import org.apache.poi.hssf.record.LeftMarginRecord;
import org.apache.poi.hssf.record.MMSRecord;
import org.apache.poi.hssf.record.MergeCellsRecord;
import org.apache.poi.hssf.record.MulBlankRecord;
import org.apache.poi.hssf.record.MulRKRecord;
import org.apache.poi.hssf.record.NameCommentRecord;
import org.apache.poi.hssf.record.NameRecord;
import org.apache.poi.hssf.record.NoteRecord;
import org.apache.poi.hssf.record.NumberRecord;
import org.apache.poi.hssf.record.ObjRecord;
import org.apache.poi.hssf.record.PaletteRecord;
import org.apache.poi.hssf.record.PaneRecord;
import org.apache.poi.hssf.record.PasswordRecord;
import org.apache.poi.hssf.record.PasswordRev4Record;
import org.apache.poi.hssf.record.PrecisionRecord;
import org.apache.poi.hssf.record.PrintGridlinesRecord;
import org.apache.poi.hssf.record.PrintHeadersRecord;
import org.apache.poi.hssf.record.PrintSetupRecord;
import org.apache.poi.hssf.record.ProtectRecord;
import org.apache.poi.hssf.record.ProtectionRev4Record;
import org.apache.poi.hssf.record.RKRecord;
import org.apache.poi.hssf.record.RecalcIdRecord;
import org.apache.poi.hssf.record.Record;
import org.apache.poi.hssf.record.RecordInputStream;
import org.apache.poi.hssf.record.RecordInputStream.LeftoverDataException;
import org.apache.poi.hssf.record.chart.*;
import org.apache.poi.hssf.record.RefModeRecord;
import org.apache.poi.hssf.record.RefreshAllRecord;
import org.apache.poi.hssf.record.RightMarginRecord;
import org.apache.poi.hssf.record.RowRecord;
import org.apache.poi.hssf.record.SCLRecord;
import org.apache.poi.hssf.record.SSTRecord;
import org.apache.poi.hssf.record.SaveRecalcRecord;
import org.apache.poi.hssf.record.SelectionRecord;
import org.apache.poi.hssf.record.SharedFormulaRecord;
import org.apache.poi.hssf.record.StringRecord;
import org.apache.poi.hssf.record.StyleRecord;
import org.apache.poi.hssf.record.SupBookRecord;
import org.apache.poi.hssf.record.TabIdRecord;
import org.apache.poi.hssf.record.TableRecord;
import org.apache.poi.hssf.record.TableStylesRecord;
import org.apache.poi.hssf.record.TextObjectRecord;
import org.apache.poi.hssf.record.TopMarginRecord;
import org.apache.poi.hssf.record.UncalcedRecord;
import org.apache.poi.hssf.record.UnknownRecord;
import org.apache.poi.hssf.record.UseSelFSRecord;
import org.apache.poi.hssf.record.VCenterRecord;
import org.apache.poi.hssf.record.VerticalPageBreakRecord;
import org.apache.poi.hssf.record.WSBoolRecord;
import org.apache.poi.hssf.record.WindowOneRecord;
import org.apache.poi.hssf.record.WindowProtectRecord;
import org.apache.poi.hssf.record.WindowTwoRecord;
import org.apache.poi.hssf.record.WriteAccessRecord;
import org.apache.poi.hssf.record.WriteProtectRecord;
import org.apache.poi.hssf.record.chart.AreaFormatRecord;
import org.apache.poi.hssf.record.chart.AreaRecord;
import org.apache.poi.hssf.record.chart.AxisLineFormatRecord;
import org.apache.poi.hssf.record.chart.AxisOptionsRecord;
import org.apache.poi.hssf.record.chart.AxisParentRecord;
import org.apache.poi.hssf.record.chart.AxisRecord;
import org.apache.poi.hssf.record.chart.AxisUsedRecord;
import org.apache.poi.hssf.record.chart.BarRecord;
import org.apache.poi.hssf.record.chart.BeginRecord;
import org.apache.poi.hssf.record.chart.CatLabRecord;
import org.apache.poi.hssf.record.chart.CategorySeriesAxisRecord;
import org.apache.poi.hssf.record.chart.ChartEndBlockRecord;
import org.apache.poi.hssf.record.chart.ChartEndObjectRecord;
import org.apache.poi.hssf.record.chart.ChartFRTInfoRecord;
import org.apache.poi.hssf.record.chart.ChartFormatRecord;
import org.apache.poi.hssf.record.chart.ChartRecord;
import org.apache.poi.hssf.record.chart.ChartStartBlockRecord;
import org.apache.poi.hssf.record.chart.ChartStartObjectRecord;
import org.apache.poi.hssf.record.chart.DatRecord;
import org.apache.poi.hssf.record.chart.DataFormatRecord;
import org.apache.poi.hssf.record.chart.DefaultDataLabelTextPropertiesRecord;
import org.apache.poi.hssf.record.chart.EndRecord;
import org.apache.poi.hssf.record.chart.FontBasisRecord;
import org.apache.poi.hssf.record.chart.FontIndexRecord;
import org.apache.poi.hssf.record.chart.FrameRecord;
import org.apache.poi.hssf.record.chart.LegendRecord;
import org.apache.poi.hssf.record.chart.LineFormatRecord;
import org.apache.poi.hssf.record.chart.LinkedDataRecord;
import org.apache.poi.hssf.record.chart.ObjectLinkRecord;
import org.apache.poi.hssf.record.chart.PlotAreaRecord;
import org.apache.poi.hssf.record.chart.PlotGrowthRecord;
import org.apache.poi.hssf.record.chart.SeriesIndexRecord;
import org.apache.poi.hssf.record.chart.SeriesListRecord;
import org.apache.poi.hssf.record.chart.SeriesRecord;
import org.apache.poi.hssf.record.chart.SeriesTextRecord;
import org.apache.poi.hssf.record.chart.SeriesToChartGroupRecord;
import org.apache.poi.hssf.record.chart.SheetPropertiesRecord;
import org.apache.poi.hssf.record.chart.TextRecord;
import org.apache.poi.hssf.record.chart.TickRecord;
import org.apache.poi.hssf.record.chart.UnitsRecord;
import org.apache.poi.hssf.record.chart.ValueRangeRecord;
import org.apache.poi.hssf.record.pivottable.DataItemRecord;
import org.apache.poi.hssf.record.pivottable.ExtendedPivotTableViewFieldsRecord;
import org.apache.poi.hssf.record.pivottable.PageItemRecord;
@ -44,7 +193,11 @@ import org.apache.poi.hssf.record.pivottable.ViewFieldsRecord;
import org.apache.poi.hssf.record.pivottable.ViewSourceRecord;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.poifs.filesystem.NPOIFSFileSystem;
import org.apache.poi.util.*;
import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger;
import org.apache.poi.util.StringUtil;
/**
* Utility for reading in BIFF8 records and displaying data from them.
@ -369,15 +522,15 @@ public final class BiffViewer {
/**
* Method main with 1 argument just run straight biffview against given
* file<P>
* file<p>
*
* <b>Usage</b>:<br/>
* <b>Usage</b>:<p>
*
* BiffViewer [--biffhex] [--noint] [--noescher] [--out] &lt;fileName&gt; <br/>
* BiffViewer --rawhex [--out] &lt;fileName&gt; <br/>
* <br/>
* BiffViewer [--biffhex] [--noint] [--noescher] [--out] &lt;fileName&gt;<p>
* BiffViewer --rawhex [--out] &lt;fileName&gt;<p>
* <p>
*
* <table>
* <table summary="BiffViewer options">
* <tr><td>--biffhex</td><td>show hex dump of each BIFF record</td></tr>
* <tr><td>--noint</td><td>do not output interpretation of BIFF records</td></tr>
* <tr><td>--out</td><td>send output to &lt;fileName&gt;.out</td></tr>

4
src/java/org/apache/poi/hssf/extractor/EventBasedExcelExtractor.java
View File

@ -57,8 +57,8 @@ import org.apache.poi.poifs.filesystem.POIFSFileSystem;
* To turn an excel file into a CSV or similar, then see
* the XLS2CSVmra example
* </p>
* <link href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/hssf/eventusermodel/examples/XLS2CSVmra.java">
* http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/hssf/eventusermodel/examples/XLS2CSVmra.java</link>
*
* @see <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/hssf/eventusermodel/examples/XLS2CSVmra.java">XLS2CSVmra</a>
*/
public class EventBasedExcelExtractor extends POIOLE2TextExtractor implements org.apache.poi.ss.extractor.ExcelExtractor {
private DirectoryNode _dir;

4
src/java/org/apache/poi/hssf/extractor/ExcelExtractor.java
View File

@ -49,8 +49,8 @@ import org.apache.poi.ss.usermodel.HeaderFooter;
* To turn an excel file into a CSV or similar, then see
* the XLS2CSVmra example
* </p>
* <link href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/hssf/eventusermodel/examples/XLS2CSVmra.java">
* http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/hssf/eventusermodel/examples/XLS2CSVmra.java</link>
*
* @see <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/hssf/eventusermodel/examples/XLS2CSVmra.java">XLS2CSVmra</a>
*/
public class ExcelExtractor extends POIOLE2TextExtractor implements org.apache.poi.ss.extractor.ExcelExtractor {
private HSSFWorkbook _wb;

2
src/java/org/apache/poi/hssf/model/InternalSheet.java
View File

@ -1075,7 +1075,7 @@ public final class InternalSheet {
* the column at specified 0-based index. (In this case, an
* ExtendedFormatRecord index is actually associated with a
* ColumnInfoRecord which spans 1 or more columns)
* <br/>
* <p>
* Returns the index to the default ExtendedFormatRecord (0xF)
* if no ColumnInfoRecord exists that includes the column
* index specified.

4
src/java/org/apache/poi/hssf/record/ArrayRecord.java
View File

@ -24,11 +24,9 @@ import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndianOutput;
/**
* ARRAY (0x0221)<p/>
* ARRAY (0x0221)<p>
*
* Treated in a similar way to SharedFormulaRecord
*
* @author Josh Micich
*/
public final class ArrayRecord extends SharedValueRecordBase implements Cloneable {

6
src/java/org/apache/poi/hssf/record/BottomMarginRecord.java
View File

@ -19,13 +19,11 @@
package org.apache.poi.hssf.record;
import org.apache.poi.util.*;
import org.apache.poi.util.LittleEndianOutput;
/**
* Record for the bottom margin.<p/>
*
* @author Shawn Laubach (slaubach at apache dot org)
* Record for the bottom margin.
*/
public final class BottomMarginRecord extends StandardRecord implements Margin, Cloneable {
public final static short sid = 0x29;

2
src/java/org/apache/poi/hssf/record/CFRuleBase.java
View File

@ -421,7 +421,7 @@ public abstract class CFRuleBase extends StandardRecord implements Cloneable {
* TODO - parse conditional format formulas properly i.e. produce tRefN and tAreaN instead of tRef and tArea
* this call will produce the wrong results if the formula contains any cell references
* One approach might be to apply the inverse of SharedFormulaRecord.convertSharedFormulas(Stack, int, int)
* Note - two extra parameters (rowIx & colIx) will be required. They probably come from one of the Region objects.
* Note - two extra parameters (rowIx &amp; colIx) will be required. They probably come from one of the Region objects.
*
* @return <code>null</code> if <tt>formula</tt> was null.
*/

6
src/java/org/apache/poi/hssf/record/CRNRecord.java
View File

@ -21,9 +21,9 @@ import org.apache.poi.ss.formula.constant.ConstantValueParser;
import org.apache.poi.util.LittleEndianOutput;
/**
* Title: CRN(0x005A) <p/>
* Description: This record stores the contents of an external cell or cell range <p/>
* REFERENCE: OOO 5.23<p/>
* Title: CRN(0x005A)<p>
* Description: This record stores the contents of an external cell or cell range<p>
* REFERENCE: OOO 5.23
*/
public final class CRNRecord extends StandardRecord {
public final static short sid = 0x005A;

7
src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java
View File

@ -23,10 +23,9 @@ import org.apache.poi.util.BitField;
import org.apache.poi.util.BitFieldFactory;
/**
* Title: COLINFO Record (0x007D)<p/>
* Description: Defines with width and formatting for a range of columns<p/>
* REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
* @author Andrew C. Oliver (acoliver at apache dot org)
* Title: COLINFO Record (0x007D)<p>
* Description: Defines with width and formatting for a range of columns<p>
* REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
*/
public final class ColumnInfoRecord extends StandardRecord implements Cloneable {
public static final short sid = 0x007D;

4
src/java/org/apache/poi/hssf/record/CommonObjectDataSubRecord.java
View File

@ -24,9 +24,7 @@ import org.apache.poi.util.LittleEndianInput;
import org.apache.poi.util.LittleEndianOutput;
/**
* The common object data record is used to store all common preferences for an excel object.<p/>
*
* @author Glen Stampoultzis (glens at apache.org)
* The common object data record is used to store all common preferences for an excel object.
*/
public final class CommonObjectDataSubRecord extends SubRecord implements Cloneable {
public final static short sid = 0x0015;

6
src/java/org/apache/poi/hssf/record/DBCellRecord.java
View File

@ -21,11 +21,9 @@ import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndianOutput;
/**
* Title: DBCell Record (0x00D7)<p/>
* Title: DBCell Record (0x00D7)<p>
* Description: Used by Excel and other MS apps to quickly find rows in the sheets.<P>
* REFERENCE: PG 299/440 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
* @author Andrew C. Oliver (acoliver at apache dot org)
* @author Jason Height
* REFERENCE: PG 299/440 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
*/
public final class DBCellRecord extends StandardRecord implements Cloneable {
public final static short sid = 0x00D7;

6
src/java/org/apache/poi/hssf/record/DConRefRecord.java
View File

@ -52,8 +52,8 @@ import org.apache.poi.util.StringUtil;
* Where
* <ul>
* <li><code>DConFile.h = 0x00</code> if the characters in<code>rgb</code> are single byte, and
* <code>DConFile.h = 0x01</code> if they are double byte. <br/>
* If they are double byte, then<br/>
* <code>DConFile.h = 0x01</code> if they are double byte.<p>
* If they are double byte, then
* <ul>
* <li> If it exists, the length of <code>DConRef.un = 2</code>. Otherwise it is 1.
* <li> The length of <code>DConFile.rgb = (2 * DConRef.cch)</code>. Otherwise it is equal to
@ -64,8 +64,6 @@ import org.apache.poi.util.StringUtil;
* </ul>
*
* At the moment this class is read-only.
*
* @author Niklas Rehfeld
*/
public class DConRefRecord extends StandardRecord
{

9
src/java/org/apache/poi/hssf/record/DSFRecord.java
View File

@ -23,11 +23,10 @@ import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndianOutput;
/**
* Title: Double Stream Flag Record (0x0161)<p/>
* Description: tells if this is a double stream file. (always no for HSSF generated files)<p/>
* Double Stream files contain both BIFF8 and BIFF7 workbooks.<p/>
* REFERENCE: PG 305 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
* @author Andrew C. Oliver (acoliver at apache dot org)
* Title: Double Stream Flag Record (0x0161)<p>
* Description: tells if this is a double stream file. (always no for HSSF generated files)<p>
* Double Stream files contain both BIFF8 and BIFF7 workbooks.<p>
* REFERENCE: PG 305 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
*/
public final class DSFRecord extends StandardRecord {
public final static short sid = 0x0161;

3
src/java/org/apache/poi/hssf/record/DVALRecord.java
View File

@ -20,10 +20,9 @@ package org.apache.poi.hssf.record;
import org.apache.poi.util.LittleEndianOutput;
/**
* Title: DATAVALIDATIONS Record (0x01B2)<p/>
* Title: DATAVALIDATIONS Record (0x01B2)<p>
* Description: used in data validation ;
* This record is the list header of all data validation records (0x01BE) in the current sheet.
* @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
*/
public final class DVALRecord extends StandardRecord implements Cloneable {
public final static short sid = 0x01B2;

4
src/java/org/apache/poi/hssf/record/DVRecord.java
View File

@ -28,13 +28,11 @@ import org.apache.poi.util.LittleEndianOutput;
import org.apache.poi.util.StringUtil;
/**
* Title: DATAVALIDATION Record (0x01BE)<p/>
* Title: DATAVALIDATION Record (0x01BE)<p>
* Description: This record stores data validation settings and a list of cell ranges
* which contain these settings. The data validation settings of a sheet
* are stored in a sequential list of DV records. This list is followed by
* DVAL record(s)
* @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
* @author Josh Micich
*/
public final class DVRecord extends StandardRecord implements Cloneable {
public final static short sid = 0x01BE;

8
src/java/org/apache/poi/hssf/record/DeltaRecord.java
View File

@ -20,11 +20,9 @@ package org.apache.poi.hssf.record;
import org.apache.poi.util.LittleEndianOutput;
/**
* Title: Delta Record (0x0010)<p/>
* Description: controls the accuracy of the calculations<p/>
* REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
* @author Andrew C. Oliver (acoliver at apache dot org)
* @author Jason Height (jheight at chariot dot net dot au)
* Title: Delta Record (0x0010)<p>
* Description: controls the accuracy of the calculations<p>
* REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
*/
public final class DeltaRecord extends StandardRecord implements Cloneable {
public final static short sid = 0x0010;

2
src/java/org/apache/poi/hssf/record/DrawingRecord.java
View File

@ -19,7 +19,7 @@ package org.apache.poi.hssf.record;
import org.apache.poi.util.LittleEndianOutput;
/**
* DrawingRecord (0x00EC)<p/>
* DrawingRecord (0x00EC)
*/
public final class DrawingRecord extends StandardRecord implements Cloneable {
public static final short sid = 0x00EC;

8
src/java/org/apache/poi/hssf/record/DrawingSelectionRecord.java
View File

@ -22,23 +22,21 @@ import org.apache.poi.util.LittleEndianInput;
import org.apache.poi.util.LittleEndianOutput;
/**
* MsoDrawingSelection (0x00ED)<p/>
* MsoDrawingSelection (0x00ED)<p>
* Reference:
* [MS-OGRAPH].pdf sec 2.4.69
*
* @author Josh Micich
*/
public final class DrawingSelectionRecord extends StandardRecord implements Cloneable {
public static final short sid = 0x00ED;
/**
* From [MS-ODRAW].pdf sec 2.2.1<br/>
* From [MS-ODRAW].pdf sec 2.2.1<p>
* TODO - make EscherRecordHeader {@link LittleEndianInput} aware and refactor with this
*/
private static final class OfficeArtRecordHeader {
public static final int ENCODED_SIZE = 8;
/**
* lower 4 bits is 'version' usually 0x01 or 0x0F (for containers)<br/>
* lower 4 bits is 'version' usually 0x01 or 0x0F (for containers)
* upper 12 bits is 'instance'
*/
private final int _verAndInstance;

4
src/java/org/apache/poi/hssf/record/EmbeddedObjectRefSubRecord.java
View File

@ -34,11 +34,9 @@ import org.apache.poi.util.POILogger;
import org.apache.poi.util.StringUtil;
/**
* ftPictFmla (0x0009)<br/>
* ftPictFmla (0x0009)<p>
* A sub-record within the OBJ record which stores a reference to an object
* stored in a separate entry within the OLE2 compound file.
*
* @author Daniel Noll
*/
public final class EmbeddedObjectRefSubRecord extends SubRecord implements Cloneable {
private static POILogger logger = POILogFactory.getLogger(EmbeddedObjectRefSubRecord.class);

9
src/java/org/apache/poi/hssf/record/EndSubRecord.java
View File

@ -21,14 +21,13 @@ import org.apache.poi.util.LittleEndianInput;
import org.apache.poi.util.LittleEndianOutput;
/**
* ftEnd (0x0000)<p/>
* ftEnd (0x0000)<p>
*
* The end data record is used to denote the end of the subrecords.<p/>
*
* @author Glen Stampoultzis (glens at apache.org)
* The end data record is used to denote the end of the subrecords.
*/
public final class EndSubRecord extends SubRecord implements Cloneable {
public final static short sid = 0x0000; // Note - zero sid is somewhat unusual (compared to plain Records)
// Note - zero sid is somewhat unusual (compared to plain Records)
public final static short sid = 0x0000;
private static final int ENCODED_SIZE = 0;
public EndSubRecord()

24
src/java/org/apache/poi/hssf/record/EscherAggregate.java
View File

@ -43,19 +43,19 @@ import org.apache.poi.util.POILogger;
* This class is used to aggregate the MSODRAWING and OBJ record
* combinations. This is necessary due to the bizare way in which
* these records are serialized. What happens is that you get a
* combination of MSODRAWING -> OBJ -> MSODRAWING -> OBJ records
* combination of MSODRAWING -&gt; OBJ -&gt; MSODRAWING -&gt; OBJ records
* but the escher records are serialized _across_ the MSODRAWING
* records.
* <p/>
* <p>
* It gets even worse when you start looking at TXO records.
* <p/>
* <p>
* So what we do with this class is aggregate lazily. That is
* we don't aggregate the MSODRAWING -> OBJ records unless we
* we don't aggregate the MSODRAWING -&gt; OBJ records unless we
* need to modify them.
* <p/>
* <p>
* At first document contains 4 types of records which belong to drawing layer.
* There are can be such sequence of record:
* <p/>
* <p>
* DrawingRecord
* ContinueRecord
* ...
@ -69,18 +69,16 @@ import org.apache.poi.util.POILogger;
* NoteRecord
* ...
* NoteRecord
* <p/>
* <p>
* To work with shapes we have to read data from Drawing and Continue records into single array of bytes and
* build escher(office art) records tree from this array.
* Each shape in drawing layer matches corresponding ObjRecord
* Each textbox matches corresponding TextObjectRecord
* <p/>
* <p>
* ObjRecord contains information about shape. Thus each ObjRecord corresponds EscherContainerRecord(SPGR)
* <p/>
* <p>
* EscherAggrefate contains also NoteRecords
* NoteRecords must be serial
*
* @author Glen Stampoultzis (glens at apache.org)
*/
public final class EscherAggregate extends AbstractEscherHolderRecord {
@ -368,7 +366,7 @@ public final class EscherAggregate extends AbstractEscherHolderRecord {
/**
* Collapses the drawing records into an aggregate.
* read Drawing, Obj, TxtObj, Note and Continue records into single byte array,
* create Escher tree from byte array, create map <EscherRecord, Record>
* create Escher tree from byte array, create map &lt;EscherRecord, Record&gt;
*
* @param records - list of all records inside sheet
* @param locFirstDrawingRecord - location of the first DrawingRecord inside sheet
@ -773,7 +771,7 @@ public final class EscherAggregate extends AbstractEscherHolderRecord {
/**
* @return unmodifiable copy of the mapping of {@link EscherClientDataRecord} and {@link EscherTextboxRecord}
* to their {@link TextObjectRecord} or {@link ObjRecord} .
* <p/>
* <p>
* We need to access it outside of EscherAggregate when building shapes
*/
public Map<EscherRecord, Record> getShapeToObjMapping() {

8
src/java/org/apache/poi/hssf/record/ExtSSTRecord.java
View File

@ -24,14 +24,12 @@ import org.apache.poi.util.LittleEndianOutput;
import java.util.ArrayList;
/**
* Title: Extended Static String Table (0x00FF)<p/>
* Title: Extended Static String Table (0x00FF)<p>
* Description: This record is used for a quick lookup into the SST record. This
* record breaks the SST table into a set of buckets. The offsets
* to these buckets within the SST record are kept as well as the
* position relative to the start of the SST record.
* REFERENCE: PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
* @author Andrew C. Oliver (acoliver at apache dot org)
* @author Jason Height (jheight at apache dot org)
* position relative to the start of the SST record.<p>
* REFERENCE: PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
*/
public final class ExtSSTRecord extends ContinuableRecord {
public final static short sid = 0x00FF;

10
src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java
View File

@ -33,9 +33,9 @@ import org.apache.poi.util.LittleEndianOutput;
* places this is better than others.
*<P>
*
* REFERENCE: PG 426 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
* @author Andrew C. Oliver (acoliver at apache dot org)
* @version 2.0-pre
* REFERENCE: PG 426 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
* @since 2.0-pre
*/
public final class ExtendedFormatRecord
@ -562,8 +562,8 @@ public final class ExtendedFormatRecord
* <p>Sets whether or not to use the pattern in this XF instead of the
* parent XF (foreground/background).</p>
*
* @param pattern <code>true</code> if this XF has a different pattern
* value than its parent,</code> false</code> otherwise.
* @param pattern {@code true} if this XF has a different pattern
* value than its parent, {@code false} otherwise.
* @see #setIndentionOptions(short)
*/

6
src/java/org/apache/poi/hssf/record/ExternSheetRecord.java
View File

@ -23,10 +23,8 @@ import java.util.List;
import org.apache.poi.util.LittleEndianOutput;
/**
* EXTERNSHEET (0x0017)<br/>
* A List of Indexes to EXTERNALBOOK (supplemental book) Records <p/>
*
* @author Libin Roman (Vista Portal LDT. Developer)
* EXTERNSHEET (0x0017)<p>
* A List of Indexes to EXTERNALBOOK (supplemental book) Records
*/
public class ExternSheetRecord extends StandardRecord {

4
src/java/org/apache/poi/hssf/record/ExternalNameRecord.java
View File

@ -24,9 +24,7 @@ import org.apache.poi.util.LittleEndianOutput;
import org.apache.poi.util.StringUtil;
/**
* EXTERNALNAME (0x0023)<p/>
*
* @author Josh Micich
* EXTERNALNAME (0x0023)
*/
public final class ExternalNameRecord extends StandardRecord {

4
src/java/org/apache/poi/hssf/record/FilePassRecord.java
View File

@ -22,11 +22,9 @@ import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndianOutput;
/**
* Title: File Pass Record (0x002F) <p/>
* Title: File Pass Record (0x002F) <p>
*
* Description: Indicates that the record after this record are encrypted.
*
* @author Jason Height (jheight at chariot dot net dot au)
*/
public final class FilePassRecord extends StandardRecord implements Cloneable {
public static final short sid = 0x002F;

7
src/java/org/apache/poi/hssf/record/FileSharingRecord.java
View File

@ -21,11 +21,10 @@ import org.apache.poi.util.LittleEndianOutput;
import org.apache.poi.util.StringUtil;
/**
* Title: FILESHARING (0x005B) <p/>
* Title: FILESHARING (0x005B) <p>
* Description: stores the encrypted readonly for a workbook (write protect)
* This functionality is accessed from the options dialog box available when performing 'Save As'.<p/>
* REFERENCE: PG 314 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
* @author Andrew C. Oliver (acoliver at apache dot org)
* This functionality is accessed from the options dialog box available when performing 'Save As'.<p>
* REFERENCE: PG 314 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
*/
public final class FileSharingRecord extends StandardRecord implements Cloneable {

7
src/java/org/apache/poi/hssf/record/FontRecord.java
View File

@ -24,11 +24,10 @@ import org.apache.poi.util.LittleEndianOutput;
import org.apache.poi.util.StringUtil;
/**
* Title: Font Record (0x0031) <p/>
* Title: Font Record (0x0031) <p>
* - describes a font in the workbook (index = 0-3,5-infinity - skip 4)<P>
* Description: An element in the Font Table<P>
* REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
* @author Andrew C. Oliver (acoliver at apache dot org)
* Description: An element in the Font Table<p>
* REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
*/
public final class FontRecord extends StandardRecord {
public final static short sid = 0x0031; // docs are wrong (0x231 Microsoft Support site article Q184647)

14
src/java/org/apache/poi/hssf/record/StandardRecord.java
View File

@ -23,8 +23,6 @@ import org.apache.poi.util.LittleEndianOutput;
/**
* Subclasses of this class (the majority of BIFF records) are non-continuable. This allows for
* some simplification of serialization logic
*
* @author Josh Micich
*/
public abstract class StandardRecord extends Record {
protected abstract int getDataSize();
@ -33,8 +31,8 @@ public abstract class StandardRecord extends Record {
}
/**
* Write the data content of this BIFF record including the sid and record length.<br/>
*
* Write the data content of this BIFF record including the sid and record length.
* <p>
* The subclass must write the exact number of bytes as reported by
* {@link org.apache.poi.hssf.record.Record#getRecordSize()}}
*/
@ -56,12 +54,12 @@ public abstract class StandardRecord extends Record {
/**
* Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields
* have already been written by the superclass.<br/>
*
* have already been written by the superclass.
* <p>
* The number of bytes written must equal the record size reported by
* {@link org.apache.poi.hssf.record.Record#getRecordSize()}} minus four
* ( record header consiting of a 'ushort sid' and 'ushort reclength' has already been written
* by thye superclass).
* ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written
* by their superclass).
*/
protected abstract void serialize(LittleEndianOutput out);
}

2
src/java/org/apache/poi/hssf/record/cont/ContinuableRecord.java
View File

@ -31,7 +31,7 @@ public abstract class ContinuableRecord extends Record {
// no fields to initialise
}
/**
* Serializes this record's content to the supplied data output.<br/>
* Serializes this record's content to the supplied data output.<p>
* The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so
* only BIFF data should be written by this method. Simple data types can be written with the
* standard {@link LittleEndianOutput} methods. Methods from {@link ContinuableRecordOutput}