try to javadoc more unsupported methods

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1914785 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/dsig/SignatureInfo.java b/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/dsig/SignatureInfo.java
index 9d9cccac01c0dc8839943cdda5ae78803f017e05..07ae49b4c2e2519a06427fffc4b23d6c8cf08daf 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/dsig/SignatureInfo.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/dsig/SignatureInfo.java
@@ -79,6 +79,7 @@ import org.apache.poi.poifs.crypt.CryptoFunctions;
 import org.apache.poi.poifs.crypt.HashAlgorithm;
 import org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet;
 import org.apache.poi.poifs.crypt.dsig.services.RelationshipTransformService;
+import org.apache.poi.util.NotImplemented;
 import org.apache.xml.security.Init;
 import org.apache.xml.security.utils.XMLUtils;
 import org.apache.xmlbeans.XmlOptions;
@@ -341,6 +342,12 @@ public class SignatureInfo {
             return new SignaturePart(sigRelPart, SignatureInfo.this);
         }
 
+        /**
+         * This method is not yet supported.
+         *
+         * @throws UnsupportedOperationException this method is not yet supported
+         */
+        @NotImplemented
         @Override
         public void remove() {
             throw new UnsupportedOperationException();
@@ -348,7 +355,6 @@ public class SignatureInfo {
     }
 
 
-
     /**
      * Helper method for adding informations before the signing.
      * Normally {@link #confirmSignature()} is sufficient to be used.

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDataSourcesFactory.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDataSourcesFactory.java
index 68bcc845033f1409f33f4a17f17625328290c0fe..8e89c3620dcf3412ddba479f7f3d329f68d18a40 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDataSourcesFactory.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDataSourcesFactory.java
@@ -383,6 +383,10 @@ public class XDDFDataSourcesFactory {
             return (Number.class.isAssignableFrom(arrayComponentType));
         }
 
+        /**
+         * @return the dataRange
+         * @throws UnsupportedOperationException if there is no Data Range Reference
+         */
         @Override
         public String getDataRangeReference() {
             if (dataRange == null) {

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
index 77f7c0e61c412415418d81ed7ab321e5039e0107..e1178470a4ce7a12165f7bfa5021b2cce1d1989c 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
@@ -53,6 +53,7 @@ import org.apache.poi.util.IOUtils;
 import org.apache.poi.util.Internal;
 import org.apache.poi.util.LittleEndian;
 import org.apache.poi.util.LittleEndianConsts;
+import org.apache.poi.util.NotImplemented;
 import org.apache.poi.util.Units;
 import org.apache.xmlbeans.XmlException;
 import org.openxmlformats.schemas.presentationml.x2006.main.CTNotesMasterIdList;
@@ -670,8 +671,14 @@ public class XMLSlideShow extends POIXMLDocument
         return _tableStyles;
     }
 
-    @SuppressWarnings("RedundantThrows")
+    /**
+     * This method is not yet supported.
+     *
+     * @throws UnsupportedOperationException this method is not yet supported
+     */
     @Override
+    @NotImplemented
+    @SuppressWarnings("RedundantThrows")
     public MasterSheet<XSLFShape, XSLFTextParagraph> createMasterSheet() throws IOException {
         // TODO: implement!
         throw new UnsupportedOperationException();

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFGraphicFrame.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFGraphicFrame.java
index c744f2ab731e8769fa8545b51667982a55b613b9..0738aba408941e15cc640028fa71b71302d6f3c0 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFGraphicFrame.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFGraphicFrame.java
@@ -37,6 +37,7 @@ import org.apache.poi.openxml4j.opc.PackageRelationship;
 import org.apache.poi.sl.usermodel.GraphicalFrame;
 import org.apache.poi.sl.usermodel.ShapeType;
 import org.apache.poi.util.Beta;
+import org.apache.poi.util.NotImplemented;
 import org.apache.poi.util.Units;
 import org.apache.xmlbeans.XmlCursor;
 import org.apache.xmlbeans.XmlException;
@@ -60,6 +61,12 @@ public class XSLFGraphicFrame extends XSLFShape implements GraphicalFrame<XSLFSh
         super(shape,sheet);
     }
 
+    /**
+     * This method is not yet supported.
+     *
+     * @throws UnsupportedOperationException this method is not yet supported
+     */
+    @NotImplemented
     public ShapeType getShapeType(){
         throw new UnsupportedOperationException();
     }

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFGroupShape.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFGroupShape.java
index 4c56fe0a01462bfc350b2a13503a42b6a4a4e868..34e9e5a624bade256f9c149077a961e3ad2a4616 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFGroupShape.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFGroupShape.java
@@ -33,6 +33,7 @@ import org.apache.poi.sl.draw.DrawPictureShape;
 import org.apache.poi.sl.usermodel.GroupShape;
 import org.apache.poi.sl.usermodel.PictureData;
 import org.apache.poi.util.Beta;
+import org.apache.poi.util.NotImplemented;
 import org.apache.poi.util.Units;
 import org.apache.xmlbeans.XmlObject;
 import org.openxmlformats.schemas.drawingml.x2006.main.CTGroupShapeProperties;
@@ -415,7 +416,14 @@ implements XSLFShapeContainer, GroupShape<XSLFShape,XSLFTextParagraph> {
         }
     }
 
+    /**
+     * This method is not yet supported.
+     *
+     * @throws UnsupportedOperationException this method is not yet supported
+     */
+    @NotImplemented
     @Override
+    @SuppressWarnings("RedundantThrows")
     public void addShape(XSLFShape shape) {
         throw new UnsupportedOperationException(
             "Adding a shape from a different container is not supported -"

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSheet.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSheet.java
index 128fcbd41ed175dd8a97a676dfcc16f0b6b96de4..ef1891da2cf0a05027f1c17538528bee4bc45747 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSheet.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSheet.java
@@ -53,6 +53,7 @@ import org.apache.poi.sl.usermodel.Sheet;
 import org.apache.poi.util.Beta;
 import org.apache.poi.util.IOUtils;
 import org.apache.poi.util.Internal;
+import org.apache.poi.util.NotImplemented;
 import org.apache.poi.util.Units;
 import org.apache.poi.xddf.usermodel.chart.XDDFChart;
 import org.apache.xmlbeans.XmlCursor;
@@ -330,6 +331,12 @@ implements XSLFShapeContainer, Sheet<XSLFShape,XSLFTextParagraph> {
         return getShapes().iterator();
     }
 
+    /**
+     * This method is not yet supported.
+     *
+     * @throws UnsupportedOperationException this method is not yet supported
+     */
+    @NotImplemented
     @Override
     public void addShape(XSLFShape shape) {
         throw new UnsupportedOperationException(

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlide.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlide.java
index 0b9e6a3212960ee93ef1f94d2926995519f18b23..2e213b9de620efae012a25f08336aed43cde7b44 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlide.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlide.java
@@ -344,11 +344,19 @@ implements Slide<XSLFShape,XSLFTextParagraph> {
         return this;
     }
 
+    /**
+     * @return always returns false
+     */
     @Override
     public boolean getFollowMasterBackground() {
         return false;
     }
 
+    /**
+     * This method is not yet supported.
+     *
+     * @throws UnsupportedOperationException this method is not yet supported
+     */
     @Override
     @NotImplemented
     public void setFollowMasterBackground(boolean follow) {
@@ -361,6 +369,11 @@ implements Slide<XSLFShape,XSLFTextParagraph> {
         return false;
     }
 
+    /**
+     * This method is not yet supported.
+     *
+     * @throws UnsupportedOperationException this method is not yet supported
+     */
     @Override
     @NotImplemented
     public void setFollowMasterColourScheme(boolean follow) {

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFRow.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFRow.java
index 42f719b52f7ef4d114e4a77aaebae244118a44e2..0e9a2db55f50669190f80125abb5a007f8bb5719 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFRow.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFRow.java
@@ -485,6 +485,12 @@ public class SXSSFRow implements Row, Comparable<SXSSFRow>
         {
             return iter.next();
         }
+
+        /**
+         * This method is not yet supported.
+         *
+         * @throws UnsupportedOperationException this method is not yet supported
+         */
         @Override
         public void remove()
         {
@@ -517,6 +523,13 @@ public class SXSSFRow implements Row, Comparable<SXSSFRow>
                 throw new NoSuchElementException();
             }
         }
+
+        /**
+         * This method is not yet supported.
+         *
+         * @throws UnsupportedOperationException this method is not yet supported
+         */
+        @NotImplemented
         @Override
         public void remove()
         {

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
index 73d05fa187a1a8a981dd49cfe7afcd05496720c7..f32ac9bb2cf29447549d87acaa24f752990301b2 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
@@ -2172,6 +2172,11 @@ public class SXSSFSheet implements Sheet, OoxmlSheetExtensions {
         pr.setTabColor(color);
     }
 
+    /**
+     * This method is not yet supported.
+     *
+     * @throws UnsupportedOperationException this method is not yet supported
+     */
     @NotImplemented
     @Override
     public void shiftColumns(int startColumn, int endColumn, int n){

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
index 4483995cfb847b317a086ddb52243b42e352ac22..84b6fba1661fe0d39b25c2ed388974bd5c52f55c 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
@@ -780,6 +780,8 @@ public class SXSSFWorkbook implements Workbook {
          * Unexpected behavior may occur if sheets are reordered after iterator
          * has been created. Support for the remove method may be added in the future
          * if someone can figure out a reliable implementation.
+         *
+         * @throws UnsupportedOperationException
          */
         @Override
         public void remove() throws IllegalStateException {

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
index dbf5ab59b93b6f95102174abbf63008c960bca47..e43bba7321622d0a395a3fed8ccaf6ca9a3e52cf 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
@@ -1325,6 +1325,8 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Date1904Su
          * Unexpected behavior may occur if sheets are reordered after iterator
          * has been created. Support for the remove method may be added in the future
          * if someone can figure out a reliable implementation.
+         *
+         * @throws UnsupportedOperationException
          */
         @Override
         public void remove() throws IllegalStateException {

diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hemf/record/emf/HemfComment.java b/poi-scratchpad/src/main/java/org/apache/poi/hemf/record/emf/HemfComment.java
index 9c4b1bcb857fd02d0514d1add7ce4bd3f26452a6..692bf4ee25422622c76bc317420c084b65f0517d 100644 (file)
--- a/poi-scratchpad/src/main/java/org/apache/poi/hemf/record/emf/HemfComment.java
+++ b/poi-scratchpad/src/main/java/org/apache/poi/hemf/record/emf/HemfComment.java
@@ -256,6 +256,11 @@ public class HemfComment {
             }
         }
 
+        /**
+         * This method is not yet supported.
+         *
+         * @throws UnsupportedOperationException this method is not yet supported
+         */
         @Override
         public void remove() {
             throw new UnsupportedOperationException("Remove not supported");

diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hemf/record/emf/HemfRecordIterator.java b/poi-scratchpad/src/main/java/org/apache/poi/hemf/record/emf/HemfRecordIterator.java
index afdcaa533f82c66faf67f820b0973d148aceb31e..64b4d176ef1dc591be8b6b1e942f2f11b1dd828c 100644 (file)
--- a/poi-scratchpad/src/main/java/org/apache/poi/hemf/record/emf/HemfRecordIterator.java
+++ b/poi-scratchpad/src/main/java/org/apache/poi/hemf/record/emf/HemfRecordIterator.java
@@ -91,6 +91,11 @@ public class HemfRecordIterator implements Iterator<HemfRecord> {
         return record;
     }
 
+    /**
+     * This method is not yet supported.
+     *
+     * @throws UnsupportedOperationException this method is not yet supported
+     */
     @Override
     public void remove() {
         throw new UnsupportedOperationException("Remove not supported");

diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hemf/record/emfplus/HemfPlusRecordIterator.java b/poi-scratchpad/src/main/java/org/apache/poi/hemf/record/emfplus/HemfPlusRecordIterator.java
index 032ef0a86cd9dab589f3a5811a61a078f597aafa..ad076ed1305ebcb1dfc77d154fc8f3c304063299 100644 (file)
--- a/poi-scratchpad/src/main/java/org/apache/poi/hemf/record/emfplus/HemfPlusRecordIterator.java
+++ b/poi-scratchpad/src/main/java/org/apache/poi/hemf/record/emfplus/HemfPlusRecordIterator.java
@@ -94,6 +94,11 @@ public class HemfPlusRecordIterator implements Iterator<HemfPlusRecord> {
         return record;
     }
 
+    /**
+     * This method is not yet supported.
+     *
+     * @throws UnsupportedOperationException this method is not yet supported
+     */
     @Override
     public void remove() {
         throw new UnsupportedOperationException("Remove not supported");

diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFGroupShape.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFGroupShape.java
index a82390e97f7e3ac66070f515ab3762befe646826..49b2d4bc6223465756fb1d5a6007b81f81c9ce25 100644 (file)
--- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFGroupShape.java
+++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFGroupShape.java
@@ -270,6 +270,11 @@ implements HSLFShapeContainer, GroupShape<HSLFShape,HSLFTextParagraph> {
         return getShapes().spliterator();
     }
 
+    /**
+     * This method is not yet supported.
+     *
+     * @throws UnsupportedOperationException this method is not yet supported
+     */
     @Override
     public boolean removeShape(HSLFShape shape) {
         // TODO: implement!

diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFPlaceholderDetails.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFPlaceholderDetails.java
index 3c279e299f4969641aeef3082ab00689c75cefe5..3957b0fffb8cd904a079ed8284f1faf7105155b6 100644 (file)
--- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFPlaceholderDetails.java
+++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFPlaceholderDetails.java
@@ -91,6 +91,9 @@ public class HSLFPlaceholderDetails implements PlaceholderDetails {
         return placeholder;
     }
 
+    /**
+     * @throws UnsupportedOperationException Only sub class(es) of HSLFPlaceholderDetails allow setting the placeholder
+     */
     @Override
     public void setPlaceholder(Placeholder placeholder) {
         throw new UnsupportedOperationException("Only sub class(es) of HSLFPlaceholderDetails allow setting the placeholder");
@@ -101,6 +104,9 @@ public class HSLFPlaceholderDetails implements PlaceholderDetails {
         return PlaceholderSize.full;
     }
 
+    /**
+     * @throws UnsupportedOperationException Only sub class(es) of HSLFPlaceholderDetails allow setting the placeholder
+     */
     @Override
     public void setSize(PlaceholderSize size) {
         throw new UnsupportedOperationException("Only sub class(es) of HSLFPlaceholderDetails allow setting the size");

diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/model/OldTextPiece.java b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/model/OldTextPiece.java
index 22289ae954b14446dca8a2406175fb85c54d3a7a..019580ced875cc8177ba3a9a1716da9ba76f100d 100644 (file)
--- a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/model/OldTextPiece.java
+++ b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/model/OldTextPiece.java
@@ -76,6 +76,7 @@ public class OldTextPiece extends TextPiece {
      *
      * @param start Local start position, in characters
      * @param end   Local end position, in characters
+     * @throws UnsupportedOperationException always throws UnsupportedOperationException
      */
     @Override
     @Deprecated

diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/usermodel/TableRow.java b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/usermodel/TableRow.java
index 9e70662eade124b553cc779dcc64040967465a80..684984ff3c508cdaa5b6181c0c81da1f447fab9c 100644 (file)
--- a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/usermodel/TableRow.java
+++ b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/usermodel/TableRow.java
@@ -63,6 +63,9 @@ public final class TableRow extends Range
         return _tprops.getFCantSplit();
     }
 
+    /**
+     * @throws UnsupportedOperationException not applicable for TableRow
+     */
     public BorderCode getBarBorder()
     {
         throw new UnsupportedOperationException( "not applicable for TableRow" );