Deprecate public annotation PdfDictionary constructors

IdamkinI · IdamkinI · commit 8eefa5e99f92 · 2017-10-11T16:36:48.000+03:00
DEVSIX-1401
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfCaretAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfCaretAnnotation.java
@@ -47,6 +47,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfArray;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfObject;
 import com.itextpdf.kernel.pdf.PdfString;
 
 public class PdfCaretAnnotation extends PdfMarkupAnnotation {
@@ -57,6 +58,11 @@ public PdfCaretAnnotation(Rectangle rect) {
         super(rect);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfCaretAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfCircleAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfCircleAnnotation.java
@@ -51,6 +51,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfArray;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfObject;
 
 public class PdfCircleAnnotation extends PdfMarkupAnnotation {
 
@@ -60,6 +61,11 @@ public PdfCircleAnnotation(Rectangle rect) {
         super(rect);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfCircleAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfFileAttachmentAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfFileAttachmentAnnotation.java
@@ -62,6 +62,11 @@ public PdfFileAttachmentAnnotation(Rectangle rect, PdfFileSpec file) {
         put(PdfName.FS, file.getPdfObject());
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfFileAttachmentAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfFreeTextAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfFreeTextAnnotation.java
@@ -48,6 +48,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
 import com.itextpdf.kernel.pdf.PdfNumber;
+import com.itextpdf.kernel.pdf.PdfObject;
 import com.itextpdf.kernel.pdf.PdfString;
 import com.itextpdf.kernel.pdf.annot.da.AnnotationDefaultAppearance;
 
@@ -85,6 +86,11 @@ public PdfFreeTextAnnotation(Rectangle rect, String appearanceString) {
         setDefaultAppearance(new PdfString(appearanceString));
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfFreeTextAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfInkAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfInkAnnotation.java
@@ -47,6 +47,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfArray;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfObject;
 
 public class PdfInkAnnotation extends PdfMarkupAnnotation {
 
@@ -61,6 +62,11 @@ public PdfInkAnnotation(Rectangle rect, PdfArray inkList) {
         put(PdfName.InkList, inkList);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfInkAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfLineAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfLineAnnotation.java
@@ -53,6 +53,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
 import com.itextpdf.kernel.pdf.PdfNumber;
+import com.itextpdf.kernel.pdf.PdfObject;
 
 /**
  * The purpose of a line annotation is to display a single straight line on the page.
@@ -80,7 +81,9 @@ public PdfLineAnnotation(Rectangle rect, float[] line) {
      * that represents annotation object. This method is useful for property reading in reading mode or
      * modifying in stamping mode.
      * @param pdfDictionary a {@link PdfDictionary} that represents existing annotation in the document.
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
      */
+    @Deprecated
     public PdfLineAnnotation(PdfDictionary pdfDictionary) {
         super(pdfDictionary);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfLinkAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfLinkAnnotation.java
@@ -68,6 +68,11 @@ public class PdfLinkAnnotation extends PdfAnnotation {
     public static final PdfName Outline = PdfName.O;
     public static final PdfName Push = PdfName.P;
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfLinkAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfPolyGeomAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfPolyGeomAnnotation.java
@@ -51,6 +51,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfArray;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfObject;
 
 public class PdfPolyGeomAnnotation extends PdfMarkupAnnotation {
 
@@ -62,12 +63,22 @@ public class PdfPolyGeomAnnotation extends PdfMarkupAnnotation {
     public static final PdfName Polygon = PdfName.Polygon;
     public static final PdfName PolyLine = PdfName.PolyLine;
 
+    /**
+     * @deprecated  Use {@link #createPolygon(Rectangle, float[])} or {@link #createPolyLine(Rectangle, float[])} instead.
+     *              Will be made private in 7.1.
+     */
+    @Deprecated
     public PdfPolyGeomAnnotation(Rectangle rect, PdfName subtype, float[] vertices) {
         super(rect);
         setSubtype(subtype);
         setVertices(vertices);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfPolyGeomAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfPopupAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfPopupAnnotation.java
@@ -47,6 +47,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfBoolean;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfObject;
 
 public class PdfPopupAnnotation extends PdfAnnotation {
 
@@ -58,6 +59,11 @@ public PdfPopupAnnotation(Rectangle rect) {
         super(rect);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfPopupAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfPrinterMarkAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfPrinterMarkAnnotation.java
@@ -46,6 +46,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.geom.Rectangle;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfObject;
 import com.itextpdf.kernel.pdf.xobject.PdfFormXObject;
 
 public class PdfPrinterMarkAnnotation extends PdfAnnotation {
@@ -58,6 +59,11 @@ public PdfPrinterMarkAnnotation(Rectangle rect, PdfFormXObject appearanceStream)
         setFlags(PdfAnnotation.PRINT | PdfAnnotation.READ_ONLY);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfPrinterMarkAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfRedactAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfRedactAnnotation.java
@@ -53,6 +53,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
 import com.itextpdf.kernel.pdf.PdfNumber;
+import com.itextpdf.kernel.pdf.PdfObject;
 import com.itextpdf.kernel.pdf.PdfStream;
 import com.itextpdf.kernel.pdf.PdfString;
 import com.itextpdf.kernel.pdf.annot.da.AnnotationDefaultAppearance;
@@ -65,6 +66,11 @@ public PdfRedactAnnotation(Rectangle rect) {
         super(rect);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfRedactAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfScreenAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfScreenAnnotation.java
@@ -46,6 +46,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.geom.Rectangle;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfObject;
 import com.itextpdf.kernel.pdf.action.PdfAction;
 
 public class PdfScreenAnnotation extends PdfAnnotation {
@@ -56,6 +57,11 @@ public PdfScreenAnnotation(Rectangle rect) {
         super(rect);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfScreenAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfSoundAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfSoundAnnotation.java
@@ -64,6 +64,11 @@ public PdfSoundAnnotation(Rectangle rect, PdfStream sound) {
         put(PdfName.Sound, sound);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfSoundAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfSquareAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfSquareAnnotation.java
@@ -51,6 +51,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfArray;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfObject;
 
 public class PdfSquareAnnotation extends PdfMarkupAnnotation {
 
@@ -60,6 +61,11 @@ public PdfSquareAnnotation(Rectangle rect) {
         super(rect);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfSquareAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfStampAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfStampAnnotation.java
@@ -47,6 +47,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfArray;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfObject;
 
 public class PdfStampAnnotation extends  PdfMarkupAnnotation {
 
@@ -56,6 +57,11 @@ public PdfStampAnnotation(Rectangle rect) {
         super(rect);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfStampAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfTextAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfTextAnnotation.java
@@ -47,6 +47,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfBoolean;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfObject;
 import com.itextpdf.kernel.pdf.PdfString;
 
 public class PdfTextAnnotation extends PdfMarkupAnnotation {
@@ -57,6 +58,11 @@ public PdfTextAnnotation(Rectangle rect) {
         super(rect);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfTextAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfTextMarkupAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfTextMarkupAnnotation.java
@@ -47,6 +47,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfArray;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfObject;
 
 public class PdfTextMarkupAnnotation extends PdfMarkupAnnotation {
 
@@ -65,6 +66,11 @@ public PdfTextMarkupAnnotation(Rectangle rect, PdfName subtype, float[] quadPoin
         setQuadPoints(new PdfArray(quadPoints));
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfTextMarkupAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfTrapNetworkAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfTrapNetworkAnnotation.java
@@ -50,6 +50,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfDate;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfObject;
 import com.itextpdf.kernel.pdf.PdfString;
 import com.itextpdf.kernel.pdf.xobject.PdfFormXObject;
 
@@ -90,7 +91,9 @@ public PdfTrapNetworkAnnotation(Rectangle rect, PdfFormXObject appearanceStream)
      * that represents annotation object. This method is useful for property reading in reading mode or
      * modifying in stamping mode.
      * @param pdfObject a {@link PdfDictionary} that represents existing annotation in the document.
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
      */
+    @Deprecated
     public PdfTrapNetworkAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfWatermarkAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfWatermarkAnnotation.java
@@ -46,6 +46,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.geom.Rectangle;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfObject;
 
 public class PdfWatermarkAnnotation extends PdfAnnotation {
 
@@ -55,6 +56,11 @@ public PdfWatermarkAnnotation(Rectangle rect) {
         super(rect);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfWatermarkAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }
diff --git a/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfWidgetAnnotation.java b/kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfWidgetAnnotation.java
@@ -65,6 +65,11 @@ public PdfWidgetAnnotation(Rectangle rect) {
         super(rect);
     }
 
+    /**
+     * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1
+     * @param pdfObject object representing this annotation
+     */
+    @Deprecated
     public PdfWidgetAnnotation(PdfDictionary pdfObject) {
         super(pdfObject);
     }

Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,11 @@ public PdfFileAttachmentAnnotation(Rectangle rect, PdfFileSpec file) {`
`62`	`62`	`put(PdfName.FS, file.getPdfObject());`
`63`	`63`	`}`
`64`	`64`
	`65`	`+ /**`
	`66`	`+ * @deprecated Use {@link PdfAnnotation#makeAnnotation(PdfObject)} instead. Will be made protected in 7.1`
	`67`	`+ * @param pdfObject object representing this annotation`
	`68`	`+ */`
	`69`	`+ @Deprecated`
`65`	`70`	`public PdfFileAttachmentAnnotation(PdfDictionary pdfObject) {`
`66`	`71`	`super(pdfObject);`
`67`	`72`	`}`