Record Class PdfBatchUtils.WatermarkJob

java.lang.Object
java.lang.Record
org.openpdf.text.pdf.PdfBatchUtils.WatermarkJob
Enclosing class:
PdfBatchUtils
public static record PdfBatchUtils.WatermarkJob(Path input, Path output, String text, float fontSize, float opacity) extends Record
Add a semi-transparent text watermark to all pages.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final float
    fontSize
    The field for the fontSize record component.
    private final Path
    input
    The field for the input record component.
    private final float
    opacity
    The field for the opacity record component.
    private final Path
    output
    The field for the output record component.
    private final String
    text
    The field for the text record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    WatermarkJob(Path input, Path output, String text, float fontSize, float opacity)
    Creates an instance of a WatermarkJob record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    float
    fontSize()
    Returns the value of the fontSize record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    Path
    input()
    Returns the value of the input record component.
    float
    opacity()
    Returns the value of the opacity record component.
    Path
    output()
    Returns the value of the output record component.
    String
    text()
    Returns the value of the text record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • input

      private final Path input
      The field for the input record component.

    • output

      private final Path output
      The field for the output record component.

    • text

      private final String text
      The field for the text record component.

    • fontSize

      private final float fontSize
      The field for the fontSize record component.

    • opacity

      private final float opacity
      The field for the opacity record component.

  • Constructor Details

    • WatermarkJob

      public WatermarkJob(Path input, Path output, String text, float fontSize, float opacity)
      Creates an instance of a WatermarkJob record class.
      Parameters:
      input - the value for the input record component
      output - the value for the output record component
      text - the value for the text record component
      fontSize - the value for the fontSize record component
      opacity - the value for the opacity record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • input

      public Path input()
      Returns the value of the input record component.
      Returns:
      the value of the input record component

    • output

      public Path output()
      Returns the value of the output record component.
      Returns:
      the value of the output record component

    • text

      public String text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component

    • fontSize

      public float fontSize()
      Returns the value of the fontSize record component.
      Returns:
      the value of the fontSize record component

    • opacity

      public float opacity()
      Returns the value of the opacity record component.
      Returns:
      the value of the opacity record component