mark classes from org.apache.poi.hwpf.model (and subpackages) as @Internal

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1155217 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Sergey Vladimirov 2011-08-09 05:53:28 +00:00
parent 9c46b3115a
commit 9f975dbc25
69 changed files with 170 additions and 18 deletions

View File

@ -1,7 +1,9 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.hwpf.model.types.BKFAbstractType; import org.apache.poi.hwpf.model.types.BKFAbstractType;
import org.apache.poi.util.Internal;
@Internal
public final class BookmarkFirstDescriptor extends BKFAbstractType implements public final class BookmarkFirstDescriptor extends BKFAbstractType implements
Cloneable Cloneable
{ {

View File

@ -20,7 +20,9 @@ import java.io.IOException;
import java.util.Arrays; import java.util.Arrays;
import org.apache.poi.hwpf.model.io.HWPFOutputStream; import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.util.Internal;
@Internal
public class BookmarksTables public class BookmarksTables
{ {
private PlexOfCps descriptorsFirst = new PlexOfCps( 4 ); private PlexOfCps descriptorsFirst = new PlexOfCps( 4 );

View File

@ -20,6 +20,7 @@ package org.apache.poi.hwpf.model;
import org.apache.poi.hwpf.sprm.CharacterSprmUncompressor; import org.apache.poi.hwpf.sprm.CharacterSprmUncompressor;
import org.apache.poi.hwpf.sprm.SprmBuffer; import org.apache.poi.hwpf.sprm.SprmBuffer;
import org.apache.poi.hwpf.usermodel.CharacterProperties; import org.apache.poi.hwpf.usermodel.CharacterProperties;
import org.apache.poi.util.Internal;
/** /**
* DANGER - works in bytes! * DANGER - works in bytes!
@ -30,6 +31,7 @@ import org.apache.poi.hwpf.usermodel.CharacterProperties;
* *
* @author Ryan Ackley * @author Ryan Ackley
*/ */
@Internal
@SuppressWarnings( "deprecation" ) @SuppressWarnings( "deprecation" )
public final class CHPX extends BytePropertyNode<CHPX> public final class CHPX extends BytePropertyNode<CHPX>
{ {

View File

@ -18,6 +18,7 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.hwpf.HWPFDocument; import org.apache.poi.hwpf.HWPFDocument;
import org.apache.poi.util.Internal;
/** /**
* Helper class for {@link HWPFDocument}, which figures out * Helper class for {@link HWPFDocument}, which figures out
@ -25,6 +26,7 @@ import org.apache.poi.hwpf.HWPFDocument;
* overall CP splurge. * overall CP splurge.
*/ */
@Deprecated @Deprecated
@Internal
public final class CPSplitCalculator { public final class CPSplitCalculator {
private FileInformationBlock fib; private FileInformationBlock fib;
public CPSplitCalculator(FileInformationBlock fib) { public CPSplitCalculator(FileInformationBlock fib) {

View File

@ -20,7 +20,9 @@ package org.apache.poi.hwpf.model;
import java.lang.ref.SoftReference; import java.lang.ref.SoftReference;
import org.apache.poi.hwpf.sprm.SprmBuffer; import org.apache.poi.hwpf.sprm.SprmBuffer;
import org.apache.poi.util.Internal;
@Internal
public final class CachedPropertyNode public final class CachedPropertyNode
extends PropertyNode<CachedPropertyNode> extends PropertyNode<CachedPropertyNode>
{ {

View File

@ -17,6 +17,9 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.Internal;
@Internal
public interface CharIndexTranslator { public interface CharIndexTranslator {
/** /**
* Calculates the byte index of the given char index. * Calculates the byte index of the given char index.

View File

@ -24,8 +24,10 @@ import java.util.List;
import org.apache.poi.hwpf.model.io.HWPFFileSystem; import org.apache.poi.hwpf.model.io.HWPFFileSystem;
import org.apache.poi.hwpf.model.io.HWPFOutputStream; import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.hwpf.sprm.SprmBuffer; import org.apache.poi.hwpf.sprm.SprmBuffer;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
@Internal
public final class ComplexFileTable public final class ComplexFileTable
{ {

View File

@ -18,12 +18,14 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.hwpf.model.types.DOPAbstractType; import org.apache.poi.hwpf.model.types.DOPAbstractType;
import org.apache.poi.util.Internal;
/** /**
* Comment me * Comment me
* *
* @author Ryan Ackley * @author Ryan Ackley
*/ */
@Internal
public final class DocumentProperties extends DOPAbstractType { public final class DocumentProperties extends DOPAbstractType {

View File

@ -25,12 +25,14 @@ import org.apache.poi.ddf.DefaultEscherRecordFactory;
import org.apache.poi.ddf.EscherContainerRecord; import org.apache.poi.ddf.EscherContainerRecord;
import org.apache.poi.ddf.EscherRecord; import org.apache.poi.ddf.EscherRecord;
import org.apache.poi.ddf.EscherRecordFactory; import org.apache.poi.ddf.EscherRecordFactory;
import org.apache.poi.util.Internal;
/** /**
* Based on AbstractEscherRecordHolder from HSSF. * Based on AbstractEscherRecordHolder from HSSF.
* *
* @author Squeeself * @author Squeeself
*/ */
@Internal
public final class EscherRecordHolder { public final class EscherRecordHolder {
private final ArrayList<EscherRecord> escherRecords; private final ArrayList<EscherRecord> escherRecords;

View File

@ -24,10 +24,12 @@ import java.util.HashSet;
import java.util.Map; import java.util.Map;
import org.apache.poi.hwpf.model.io.HWPFOutputStream; import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.POILogFactory; import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger; import org.apache.poi.util.POILogger;
@Internal
public final class FIBFieldHandler public final class FIBFieldHandler
{ {
// 154 == 0x009A; 158 == 0x009E // 154 == 0x009A; 158 == 0x009E

View File

@ -17,12 +17,14 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
* Handles the fibRgLw / The FibRgLw97 part of * Handles the fibRgLw / The FibRgLw97 part of
* the FIB (File Information Block) * the FIB (File Information Block)
*/ */
@Internal
public final class FIBLongHandler { public final class FIBLongHandler {
public static final int CBMAC = 0; public static final int CBMAC = 0;
public static final int PRODUCTCREATED = 1; public static final int PRODUCTCREATED = 1;

View File

@ -17,12 +17,14 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
* Handles the fibRgW / FibRgW97 part of * Handles the fibRgW / FibRgW97 part of
* the FIB (File Information Block) * the FIB (File Information Block)
*/ */
@Internal
public final class FIBShortHandler { public final class FIBShortHandler {
public final static int MAGICCREATED = 0; public final static int MAGICCREATED = 0;
public final static int MAGICREVISED = 1; public final static int MAGICREVISED = 1;

View File

@ -1,5 +1,8 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.Internal;
@Internal
public enum FSPADocumentPart { public enum FSPADocumentPart {
HEADER( FIBFieldHandler.PLCSPAHDR ), HEADER( FIBFieldHandler.PLCSPAHDR ),

View File

@ -17,10 +17,12 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import java.util.Arrays;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.BitFieldFactory; import org.apache.poi.util.BitFieldFactory;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
import java.util.Arrays;
/** /**
* FFN - Font Family Name. FFN is a data structure that stores the names of the Main * FFN - Font Family Name. FFN is a data structure that stores the names of the Main
@ -29,6 +31,7 @@ import java.util.Arrays;
* *
* @author Praveen Mathew * @author Praveen Mathew
*/ */
@Internal
public final class Ffn public final class Ffn
{ {
private int _cbFfnM1;//total length of FFN - 1. private int _cbFfnM1;//total length of FFN - 1.

View File

@ -18,12 +18,14 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.hwpf.model.types.FLDAbstractType; import org.apache.poi.hwpf.model.types.FLDAbstractType;
import org.apache.poi.util.Internal;
/** /**
* Class for the FLD structure. * Class for the FLD structure.
* *
* @author Cedric Bosdonnat <cbosdonnat@novell.com> * @author Cedric Bosdonnat <cbosdonnat@novell.com>
*/ */
@Internal
public final class FieldDescriptor extends FLDAbstractType public final class FieldDescriptor extends FLDAbstractType
{ {
public static final int FIELD_BEGIN_MARK = 0x13; public static final int FIELD_BEGIN_MARK = 0x13;

View File

@ -1,5 +1,8 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.Internal;
@Internal
public enum FieldsDocumentPart { public enum FieldsDocumentPart {
/** /**

View File

@ -25,6 +25,7 @@ import java.util.HashMap;
import java.util.Map; import java.util.Map;
import org.apache.poi.hwpf.model.io.HWPFOutputStream; import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.util.Internal;
/** /**
* This class provides access to all the fields Plex. * This class provides access to all the fields Plex.
@ -32,6 +33,7 @@ import org.apache.poi.hwpf.model.io.HWPFOutputStream;
* @author Cedric Bosdonnat <cbosdonnat@novell.com> * @author Cedric Bosdonnat <cbosdonnat@novell.com>
* *
*/ */
@Internal
public class FieldsTables public class FieldsTables
{ {
// The size in bytes of the FLD data structure // The size in bytes of the FLD data structure

View File

@ -24,6 +24,7 @@ import java.util.HashSet;
import org.apache.poi.hwpf.model.io.HWPFOutputStream; import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.hwpf.model.types.FIBAbstractType; import org.apache.poi.hwpf.model.types.FIBAbstractType;
import org.apache.poi.util.Internal;
/** /**
* The File Information Block (FIB). Holds pointers * The File Information Block (FIB). Holds pointers
@ -41,6 +42,7 @@ import org.apache.poi.hwpf.model.types.FIBAbstractType;
* *
* @author andy * @author andy
*/ */
@Internal
public final class FileInformationBlock extends FIBAbstractType public final class FileInformationBlock extends FIBAbstractType
implements Cloneable implements Cloneable
{ {

View File

@ -18,8 +18,10 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import java.io.IOException; import java.io.IOException;
import org.apache.poi.hwpf.model.io.HWPFFileSystem; import org.apache.poi.hwpf.model.io.HWPFFileSystem;
import org.apache.poi.hwpf.model.io.HWPFOutputStream; import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.POILogFactory; import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger; import org.apache.poi.util.POILogger;
@ -32,6 +34,7 @@ import org.apache.poi.util.POILogger;
* *
* @author Praveen Mathew * @author Praveen Mathew
*/ */
@Internal
public final class FontTable public final class FontTable
{ {
private final static POILogger _logger = POILogFactory.getLogger(FontTable.class); private final static POILogger _logger = POILogFactory.getLogger(FontTable.class);

View File

@ -17,7 +17,9 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.hwpf.model.types.FRDAbstractType; import org.apache.poi.hwpf.model.types.FRDAbstractType;
import org.apache.poi.util.Internal;
@Internal
public final class FootnoteReferenceDescriptor extends FRDAbstractType public final class FootnoteReferenceDescriptor extends FRDAbstractType
implements Cloneable implements Cloneable
{ {

View File

@ -17,6 +17,7 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -39,6 +40,7 @@ import org.apache.poi.util.LittleEndian;
* *
* @author Ryan Ackley * @author Ryan Ackley
*/ */
@Internal
public abstract class FormattedDiskPage public abstract class FormattedDiskPage
{ {
protected byte[] _fkp; protected byte[] _fkp;

View File

@ -17,6 +17,9 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.Internal;
@Internal
public final class GenericPropertyNode public final class GenericPropertyNode
extends PropertyNode<GenericPropertyNode> extends PropertyNode<GenericPropertyNode>
{ {

View File

@ -17,10 +17,14 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.Internal;
/** /**
* *
* @author andy * @author andy
*/ */
@Internal
@Deprecated
public interface HDFType { public interface HDFType {
} }

View File

@ -19,6 +19,7 @@ package org.apache.poi.hwpf.model;
import org.apache.poi.hwpf.model.types.HRESIAbstractType; import org.apache.poi.hwpf.model.types.HRESIAbstractType;
import org.apache.poi.hwpf.usermodel.CharacterProperties; import org.apache.poi.hwpf.usermodel.CharacterProperties;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -26,6 +27,7 @@ import org.apache.poi.util.LittleEndian;
* *
* @author Sergey Vladimirov ( vlsergey {at} gmail {dot} com ) * @author Sergey Vladimirov ( vlsergey {at} gmail {dot} com )
*/ */
@Internal
public final class Hyphenation extends HRESIAbstractType implements Cloneable public final class Hyphenation extends HRESIAbstractType implements Cloneable
{ {
public Hyphenation() public Hyphenation()

View File

@ -17,12 +17,14 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.BitField;
import org.apache.poi.util.BitFieldFactory;
import org.apache.poi.util.LittleEndian;
import java.util.Arrays; import java.util.Arrays;
import org.apache.poi.util.BitField;
import org.apache.poi.util.BitFieldFactory;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian;
@Internal
public final class ListData public final class ListData
{ {
private int _lsid; private int _lsid;

View File

@ -18,7 +18,9 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.hwpf.model.types.LFOAbstractType; import org.apache.poi.hwpf.model.types.LFOAbstractType;
import org.apache.poi.util.Internal;
@Internal
public final class ListFormatOverride extends LFOAbstractType public final class ListFormatOverride extends LFOAbstractType
{ {
private ListFormatOverrideLevel[] _levelOverrides; private ListFormatOverrideLevel[] _levelOverrides;

View File

@ -17,12 +17,14 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.BitField;
import org.apache.poi.util.BitFieldFactory;
import java.util.Arrays; import java.util.Arrays;
import org.apache.poi.util.BitField;
import org.apache.poi.util.BitFieldFactory;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian;
@Internal
public final class ListFormatOverrideLevel public final class ListFormatOverrideLevel
{ {
private static final int BASE_SIZE = 8; private static final int BASE_SIZE = 8;

View File

@ -20,6 +20,7 @@ package org.apache.poi.hwpf.model;
import java.util.Arrays; import java.util.Arrays;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -27,6 +28,7 @@ import org.apache.poi.util.LittleEndian;
* *
* See page 170 for details. * See page 170 for details.
*/ */
@Internal
public final class ListLevel public final class ListLevel
{ {
private static final int RGBXCH_NUMS_SIZE = 9; private static final int RGBXCH_NUMS_SIZE = 9;

View File

@ -30,6 +30,7 @@ import java.util.NoSuchElementException;
import java.util.Set; import java.util.Set;
import org.apache.poi.hwpf.model.io.HWPFOutputStream; import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.POILogFactory; import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger; import org.apache.poi.util.POILogger;
@ -37,6 +38,7 @@ import org.apache.poi.util.POILogger;
/** /**
* @author Ryan Ackley * @author Ryan Ackley
*/ */
@Internal
public final class ListTables public final class ListTables
{ {
private static final int LIST_DATA_SIZE = 28; private static final int LIST_DATA_SIZE = 28;

View File

@ -22,6 +22,9 @@
*/ */
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.Internal;
@Internal
public enum NoteType { public enum NoteType {
/** Ending note */ /** Ending note */
ENDNOTE( FIBFieldHandler.PLCFENDREF, FIBFieldHandler.PLCFENDTXT ), ENDNOTE( FIBFieldHandler.PLCFENDREF, FIBFieldHandler.PLCFENDTXT ),

View File

@ -19,12 +19,14 @@ package org.apache.poi.hwpf.model;
import java.io.IOException; import java.io.IOException;
import org.apache.poi.hwpf.model.io.HWPFOutputStream; import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.util.Internal;
/** /**
* Holds information about document notes (footnotes or ending notes) * Holds information about document notes (footnotes or ending notes)
* *
* @author Sergey Vladimirov (vlsergey {at} gmail {doc} com) * @author Sergey Vladimirov (vlsergey {at} gmail {doc} com)
*/ */
@Internal
public class NotesTables public class NotesTables
{ {
private PlexOfCps descriptors = new PlexOfCps( private PlexOfCps descriptors = new PlexOfCps(

View File

@ -20,6 +20,7 @@ package org.apache.poi.hwpf.model;
import java.util.Collections; import java.util.Collections;
import org.apache.poi.poifs.common.POIFSConstants; import org.apache.poi.poifs.common.POIFSConstants;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -30,6 +31,7 @@ import org.apache.poi.util.LittleEndian;
* In common with the rest of the old support, it * In common with the rest of the old support, it
* is read only * is read only
*/ */
@Internal
public final class OldCHPBinTable extends CHPBinTable public final class OldCHPBinTable extends CHPBinTable
{ {
/** /**

View File

@ -20,6 +20,7 @@ package org.apache.poi.hwpf.model;
import java.util.Collections; import java.util.Collections;
import org.apache.poi.poifs.common.POIFSConstants; import org.apache.poi.poifs.common.POIFSConstants;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -30,6 +31,7 @@ import org.apache.poi.util.LittleEndian;
* In common with the rest of the old support, it * In common with the rest of the old support, it
* is read only * is read only
*/ */
@Internal
public final class OldPAPBinTable extends PAPBinTable public final class OldPAPBinTable extends PAPBinTable
{ {

View File

@ -19,6 +19,7 @@ package org.apache.poi.hwpf.model;
import java.util.Collections; import java.util.Collections;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -29,6 +30,7 @@ import org.apache.poi.util.LittleEndian;
* In common with the rest of the old support, it * In common with the rest of the old support, it
* is read only * is read only
*/ */
@Internal
public final class OldSectionTable extends SectionTable public final class OldSectionTable extends SectionTable
{ {
/** /**

View File

@ -17,13 +17,15 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import java.io.OutputStream;
import java.io.IOException; import java.io.IOException;
import java.io.OutputStream;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.BitFieldFactory; import org.apache.poi.util.BitFieldFactory;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
@Internal
public final class ParagraphHeight public final class ParagraphHeight
{ {
private short infoField; private short infoField;

View File

@ -2,6 +2,7 @@ package org.apache.poi.hwpf.model;
import java.util.Arrays; import java.util.Arrays;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -12,6 +13,7 @@ import org.apache.poi.util.LittleEndian;
* *
* @author Sergey Vladimirov ( vlsergey {at} gmail {dot} com ) * @author Sergey Vladimirov ( vlsergey {at} gmail {dot} com )
*/ */
@Internal
public class PictureDescriptor public class PictureDescriptor
{ {
private static final int LCB_OFFSET = 0x00; private static final int LCB_OFFSET = 0x00;

View File

@ -29,6 +29,7 @@ import org.apache.poi.hwpf.HWPFDocument;
import org.apache.poi.hwpf.usermodel.CharacterRun; import org.apache.poi.hwpf.usermodel.CharacterRun;
import org.apache.poi.hwpf.usermodel.Picture; import org.apache.poi.hwpf.usermodel.Picture;
import org.apache.poi.hwpf.usermodel.Range; import org.apache.poi.hwpf.usermodel.Range;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -48,6 +49,7 @@ import org.apache.poi.util.LittleEndian;
* *
* @author Dmitry Romanov * @author Dmitry Romanov
*/ */
@Internal
public final class PicturesTable public final class PicturesTable
{ {
static final int TYPE_IMAGE = 0x08; static final int TYPE_IMAGE = 0x08;

View File

@ -19,8 +19,10 @@ package org.apache.poi.hwpf.model;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.BitFieldFactory; import org.apache.poi.util.BitFieldFactory;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
@Internal
public final class PieceDescriptor public final class PieceDescriptor
{ {

View File

@ -21,12 +21,14 @@ package org.apache.poi.hwpf.model;
import java.text.MessageFormat; import java.text.MessageFormat;
import org.apache.poi.util.Internal;
/** /**
* Structure describing the Plex for fields (contained plclfd* in the spec). * Structure describing the Plex for fields (contained plclfd* in the spec).
* *
* @author Cedric Bosdonnat <cbosdonnat@novell.com> * @author Cedric Bosdonnat <cbosdonnat@novell.com>
*
*/ */
@Internal
public class PlexOfField public class PlexOfField
{ {

View File

@ -1,7 +1,9 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.Internal;
@Internal
public final class PropertyModifier implements Cloneable public final class PropertyModifier implements Cloneable
{ {
/** /**

View File

@ -20,6 +20,7 @@ package org.apache.poi.hwpf.model;
import java.util.Arrays; import java.util.Arrays;
import java.util.Comparator; import java.util.Comparator;
import org.apache.poi.util.Internal;
import org.apache.poi.util.POILogFactory; import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger; import org.apache.poi.util.POILogger;
@ -32,6 +33,7 @@ import org.apache.poi.util.POILogger;
* *
* @author Ryan Ackley * @author Ryan Ackley
*/ */
@Internal
public abstract class PropertyNode<T extends PropertyNode<T>> implements Comparable<T>, Cloneable public abstract class PropertyNode<T extends PropertyNode<T>> implements Comparable<T>, Cloneable
{ {

View File

@ -22,17 +22,18 @@ import java.util.Arrays;
import java.util.Collections; import java.util.Collections;
import java.util.List; import java.util.List;
import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.StringUtil; import org.apache.poi.util.StringUtil;
import org.apache.poi.hwpf.model.io.HWPFOutputStream;
/** /**
* String table containing the names of authors of revision marks, e-mails and * String table containing the names of authors of revision marks, e-mails and
* comments in this document. * comments in this document.
* *
* @author Ryan Lauck * @author Ryan Lauck
*/ */
@Internal
public final class RevisionMarkAuthorTable { public final class RevisionMarkAuthorTable {
/** /**
* must be 0xFFFF * must be 0xFFFF

View File

@ -21,7 +21,9 @@ import org.apache.poi.hwpf.sprm.SectionSprmCompressor;
import org.apache.poi.hwpf.sprm.SectionSprmUncompressor; import org.apache.poi.hwpf.sprm.SectionSprmUncompressor;
import org.apache.poi.hwpf.sprm.SprmBuffer; import org.apache.poi.hwpf.sprm.SprmBuffer;
import org.apache.poi.hwpf.usermodel.SectionProperties; import org.apache.poi.hwpf.usermodel.SectionProperties;
import org.apache.poi.util.Internal;
@Internal
public final class SEPX extends PropertyNode<SEPX> public final class SEPX extends PropertyNode<SEPX>
{ {

View File

@ -17,12 +17,15 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.Internal;
/** /**
* A single entry in the {@link SavedByTable}. * A single entry in the {@link SavedByTable}.
* *
* @author Daniel Noll * @author Daniel Noll
*/ */
@Internal
public final class SavedByEntry public final class SavedByEntry
{ {
private String userName; private String userName;

View File

@ -23,6 +23,7 @@ import java.util.Collections;
import java.util.List; import java.util.List;
import org.apache.poi.hwpf.model.io.HWPFOutputStream; import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.util.Internal;
/** /**
* String table containing the history of the last few revisions ("saves") of the document. * String table containing the history of the last few revisions ("saves") of the document.
@ -30,6 +31,7 @@ import org.apache.poi.hwpf.model.io.HWPFOutputStream;
* *
* @author Daniel Noll * @author Daniel Noll
*/ */
@Internal
public final class SavedByTable public final class SavedByTable
{ {

View File

@ -17,6 +17,7 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -24,6 +25,7 @@ import org.apache.poi.util.LittleEndian;
* *
* @see page 186 for details * @see page 186 for details
*/ */
@Internal
public final class SectionDescriptor public final class SectionDescriptor
{ {

View File

@ -24,6 +24,7 @@ import java.util.List;
import org.apache.poi.hwpf.model.io.HWPFFileSystem; import org.apache.poi.hwpf.model.io.HWPFFileSystem;
import org.apache.poi.hwpf.model.io.HWPFOutputStream; import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.POILogFactory; import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger; import org.apache.poi.util.POILogger;
@ -31,6 +32,7 @@ import org.apache.poi.util.POILogger;
/** /**
* @author Ryan Ackley * @author Ryan Ackley
*/ */
@Internal
public class SectionTable public class SectionTable
{ {
private final static POILogger _logger = POILogFactory.getLogger(SectionTable.class); private final static POILogger _logger = POILogFactory.getLogger(SectionTable.class);

View File

@ -21,7 +21,9 @@ import java.util.ArrayList;
import java.util.List; import java.util.List;
import org.apache.poi.hwpf.usermodel.Shape; import org.apache.poi.hwpf.usermodel.Shape;
import org.apache.poi.util.Internal;
@Internal
@Deprecated @Deprecated
public final class ShapesTable { public final class ShapesTable {
private List<Shape> _shapes; private List<Shape> _shapes;

View File

@ -3,6 +3,7 @@ package org.apache.poi.hwpf.model;
import java.io.IOException; import java.io.IOException;
import org.apache.poi.hwpf.model.io.HWPFOutputStream; import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.StringUtil; import org.apache.poi.util.StringUtil;
@ -11,6 +12,7 @@ import org.apache.poi.util.StringUtil;
* *
* @author Sergey Vladimirov (vlsergey {at} gmail {dot} com) * @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
*/ */
@Internal
class SttbfUtils class SttbfUtils
{ {
public static String[] read( byte[] data, int startOffset ) public static String[] read( byte[] data, int startOffset )

View File

@ -22,15 +22,16 @@ import java.util.Arrays;
import org.apache.poi.hwpf.usermodel.CharacterProperties; import org.apache.poi.hwpf.usermodel.CharacterProperties;
import org.apache.poi.hwpf.usermodel.ParagraphProperties; import org.apache.poi.hwpf.usermodel.ParagraphProperties;
import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.BitFieldFactory; import org.apache.poi.util.BitFieldFactory;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian;
/** /**
* Comment me * Comment me
* *
* @author Ryan Ackley * @author Ryan Ackley
*/ */
@Internal
public final class StyleDescription implements HDFType public final class StyleDescription implements HDFType
{ {

View File

@ -19,12 +19,13 @@ package org.apache.poi.hwpf.model;
import java.io.IOException; import java.io.IOException;
import org.apache.poi.util.LittleEndian;
import org.apache.poi.hwpf.model.io.HWPFOutputStream; import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.hwpf.sprm.CharacterSprmUncompressor;
import org.apache.poi.hwpf.sprm.ParagraphSprmUncompressor;
import org.apache.poi.hwpf.usermodel.CharacterProperties; import org.apache.poi.hwpf.usermodel.CharacterProperties;
import org.apache.poi.hwpf.usermodel.ParagraphProperties; import org.apache.poi.hwpf.usermodel.ParagraphProperties;
import org.apache.poi.hwpf.sprm.ParagraphSprmUncompressor; import org.apache.poi.util.Internal;
import org.apache.poi.hwpf.sprm.CharacterSprmUncompressor; import org.apache.poi.util.LittleEndian;
/** /**
* Represents a document's stylesheet. A word documents formatting is stored as * Represents a document's stylesheet. A word documents formatting is stored as
@ -34,6 +35,7 @@ import org.apache.poi.hwpf.sprm.CharacterSprmUncompressor;
* *
* @author Ryan Ackley * @author Ryan Ackley
*/ */
@Internal
public final class StyleSheet implements HDFType { public final class StyleSheet implements HDFType {
public static final int NIL_STYLE = 4095; public static final int NIL_STYLE = 4095;

View File

@ -1,10 +1,13 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.Internal;
/** /**
* Document text parts that can have text pieces (CPs) * Document text parts that can have text pieces (CPs)
* *
* @author Sergey Vladimirov (vlsergey {at} gmail {dot} com) * @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
*/ */
@Internal
public enum SubdocumentType { public enum SubdocumentType {
MAIN( FIBLongHandler.CCPTEXT ), MAIN( FIBLongHandler.CCPTEXT ),

View File

@ -24,6 +24,7 @@ import java.util.List;
import org.apache.poi.hwpf.model.io.HWPFOutputStream; import org.apache.poi.hwpf.model.io.HWPFOutputStream;
import org.apache.poi.poifs.common.POIFSConstants; import org.apache.poi.poifs.common.POIFSConstants;
import org.apache.poi.util.Internal;
import org.apache.poi.util.POILogFactory; import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger; import org.apache.poi.util.POILogger;
@ -34,6 +35,7 @@ import org.apache.poi.util.POILogger;
* *
* @author Ryan Ackley * @author Ryan Ackley
*/ */
@Internal
public class TextPieceTable implements CharIndexTranslator public class TextPieceTable implements CharIndexTranslator
{ {
private static final POILogger logger = POILogFactory private static final POILogger logger = POILogFactory

View File

@ -19,6 +19,9 @@ package org.apache.poi.hwpf.model;
import java.util.Arrays; import java.util.Arrays;
import org.apache.poi.util.Internal;
@Internal
public final class UPX public final class UPX
{ {
private byte[] _upx; private byte[] _upx;

View File

@ -17,6 +17,9 @@
package org.apache.poi.hwpf.model; package org.apache.poi.hwpf.model;
import org.apache.poi.util.Internal;
@Internal
public final class UnhandledDataStructure public final class UnhandledDataStructure
{ {
byte[] _buf; byte[] _buf;

View File

@ -21,6 +21,9 @@ package org.apache.poi.hwpf.model.io;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
import org.apache.poi.util.Internal;
@Internal
public final class HWPFFileSystem public final class HWPFFileSystem
{ {
Map<String, HWPFOutputStream> _streams = new HashMap<String, HWPFOutputStream>(); Map<String, HWPFOutputStream> _streams = new HashMap<String, HWPFOutputStream>();

View File

@ -19,6 +19,9 @@ package org.apache.poi.hwpf.model.io;
import java.io.ByteArrayOutputStream; import java.io.ByteArrayOutputStream;
import org.apache.poi.util.Internal;
@Internal
public final class HWPFOutputStream extends ByteArrayOutputStream public final class HWPFOutputStream extends ByteArrayOutputStream
{ {

View File

@ -2,6 +2,7 @@
package org.apache.poi.hwpf.model.types; package org.apache.poi.hwpf.model.types;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -16,6 +17,7 @@ import org.apache.poi.util.LittleEndian;
* @author Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary * @author Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary
* File Format (.doc) Specification * File Format (.doc) Specification
*/ */
@Internal
public abstract class BKFAbstractType public abstract class BKFAbstractType
{ {

View File

@ -21,6 +21,7 @@ package org.apache.poi.hwpf.model.types;
import org.apache.poi.hdf.model.hdftypes.HDFType; import org.apache.poi.hdf.model.hdftypes.HDFType;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.BitFieldFactory; import org.apache.poi.util.BitFieldFactory;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -30,6 +31,7 @@ import org.apache.poi.util.LittleEndian;
* *
* @author S. Ryan Ackley * @author S. Ryan Ackley
*/ */
@Internal
public abstract class DOPAbstractType implements HDFType { public abstract class DOPAbstractType implements HDFType {
protected byte field_1_formatFlags; protected byte field_1_formatFlags;

View File

@ -21,6 +21,7 @@ package org.apache.poi.hwpf.model.types;
import org.apache.poi.hdf.model.hdftypes.HDFType; import org.apache.poi.hdf.model.hdftypes.HDFType;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.BitFieldFactory; import org.apache.poi.util.BitFieldFactory;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -30,6 +31,7 @@ import org.apache.poi.util.LittleEndian;
* *
* @author Andrew C. Oliver * @author Andrew C. Oliver
*/ */
@Internal
public abstract class FIBAbstractType implements HDFType { public abstract class FIBAbstractType implements HDFType {
protected int field_1_wIdent; protected int field_1_wIdent;

View File

@ -19,6 +19,7 @@ package org.apache.poi.hwpf.model.types;
import org.apache.poi.hdf.model.hdftypes.HDFType; import org.apache.poi.hdf.model.hdftypes.HDFType;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.Internal;
/** /**
* Field Descriptor (FLD). * Field Descriptor (FLD).
@ -32,6 +33,7 @@ import org.apache.poi.util.BitField;
* @author Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary * @author Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary
* File Format Specification [*.doc] * File Format Specification [*.doc]
*/ */
@Internal
public abstract class FLDAbstractType implements HDFType public abstract class FLDAbstractType implements HDFType
{ {

View File

@ -16,6 +16,7 @@
==================================================================== */ ==================================================================== */
package org.apache.poi.hwpf.model.types; package org.apache.poi.hwpf.model.types;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -30,6 +31,7 @@ import org.apache.poi.util.LittleEndian;
* @author Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary * @author Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary
* File Format (.doc) Specification * File Format (.doc) Specification
*/ */
@Internal
public abstract class FRDAbstractType public abstract class FRDAbstractType
{ {

View File

@ -17,6 +17,8 @@
package org.apache.poi.hwpf.model.types; package org.apache.poi.hwpf.model.types;
import org.apache.poi.util.Internal;
/** /**
* Hyphenation (HRESI). * Hyphenation (HRESI).
* <p> * <p>
@ -29,6 +31,7 @@ package org.apache.poi.hwpf.model.types;
* @author Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary * @author Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary
* File Format (.doc) Specification * File Format (.doc) Specification
*/ */
@Internal
public abstract class HRESIAbstractType public abstract class HRESIAbstractType
{ {

View File

@ -17,6 +17,7 @@
package org.apache.poi.hwpf.model.types; package org.apache.poi.hwpf.model.types;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -31,6 +32,7 @@ import org.apache.poi.util.LittleEndian;
* @author Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary * @author Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary
* File Format Specification [*.doc] * File Format Specification [*.doc]
*/ */
@Internal
public abstract class LFOAbstractType public abstract class LFOAbstractType
{ {

View File

@ -23,6 +23,7 @@ import org.apache.poi.hwpf.usermodel.DropCapSpecifier;
import org.apache.poi.hwpf.usermodel.LineSpacingDescriptor; import org.apache.poi.hwpf.usermodel.LineSpacingDescriptor;
import org.apache.poi.hwpf.usermodel.ShadingDescriptor; import org.apache.poi.hwpf.usermodel.ShadingDescriptor;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.Internal;
/** /**
* Paragraph Properties. * Paragraph Properties.
@ -31,6 +32,7 @@ import org.apache.poi.util.BitField;
* @author S. Ryan Ackley * @author S. Ryan Ackley
*/ */
@Internal
public abstract class PAPAbstractType public abstract class PAPAbstractType
{ {

View File

@ -20,6 +20,7 @@ package org.apache.poi.hwpf.model.types;
import org.apache.poi.hwpf.usermodel.BorderCode; import org.apache.poi.hwpf.usermodel.BorderCode;
import org.apache.poi.hwpf.usermodel.DateAndTime; import org.apache.poi.hwpf.usermodel.DateAndTime;
import org.apache.poi.util.Internal;
/** /**
* Section Properties. * Section Properties.
@ -28,6 +29,7 @@ import org.apache.poi.hwpf.usermodel.DateAndTime;
* *
* @author S. Ryan Ackley * @author S. Ryan Ackley
*/ */
@Internal
public abstract class SEPAbstractType public abstract class SEPAbstractType
{ {

View File

@ -23,6 +23,7 @@ import org.apache.poi.hwpf.usermodel.ShadingDescriptor;
import org.apache.poi.hwpf.usermodel.TableAutoformatLookSpecifier; import org.apache.poi.hwpf.usermodel.TableAutoformatLookSpecifier;
import org.apache.poi.hwpf.usermodel.TableCellDescriptor; import org.apache.poi.hwpf.usermodel.TableCellDescriptor;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.Internal;
/** /**
* "Table Properties (TAP). This structure is never written out to disk but can * "Table Properties (TAP). This structure is never written out to disk but can
@ -38,6 +39,7 @@ import org.apache.poi.util.BitField;
* @author S. Ryan Ackley * @author S. Ryan Ackley
* @author Sergey Vladimirov (vlsergey {at} gmail {dot} com) * @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
*/ */
@Internal
public abstract class TAPAbstractType implements HDFType public abstract class TAPAbstractType implements HDFType
{ {

View File

@ -22,6 +22,7 @@ package org.apache.poi.hwpf.model.types;
import org.apache.poi.hdf.model.hdftypes.HDFType; import org.apache.poi.hdf.model.hdftypes.HDFType;
import org.apache.poi.hwpf.usermodel.BorderCode; import org.apache.poi.hwpf.usermodel.BorderCode;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.Internal;
/** /**
* Table Cell Descriptor. * Table Cell Descriptor.
@ -30,6 +31,7 @@ import org.apache.poi.util.BitField;
* @author S. Ryan Ackley * @author S. Ryan Ackley
*/ */
@Internal
public abstract class TCAbstractType public abstract class TCAbstractType
implements HDFType implements HDFType
{ {

View File

@ -19,6 +19,7 @@ package org.apache.poi.hwpf.model.types;
import org.apache.poi.hdf.model.hdftypes.HDFType; import org.apache.poi.hdf.model.hdftypes.HDFType;
import org.apache.poi.util.BitField; import org.apache.poi.util.BitField;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndian;
/** /**
@ -33,6 +34,7 @@ import org.apache.poi.util.LittleEndian;
* @author Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary * @author Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary
* File Format Specification [*.doc] * File Format Specification [*.doc]
*/ */
@Internal
public abstract class TLPAbstractType implements HDFType public abstract class TLPAbstractType implements HDFType
{ {