Record Class Paragraphs

java.lang.Object
java.lang.Record
pro.verron.officestamper.preset.Paragraphs
Record Components:
comment - the comment metadata associated with the paragraphs
data - an iterator over the data elements in the paragraphs
elements - a list of objects representing elements in the paragraphs
previousSectionBreak - an optional previous section break associated with the paragraphs
oddNumberOfBreaks - a flag indicating if there is an odd number of breaks
public record Paragraphs(Comment comment, Iterator<Object> data, List<Object> elements, Optional<org.docx4j.wml.SectPr> previousSectionBreak, boolean oddNumberOfBreaks) extends Record

Represents a collection of paragraphs in a document, providing various methods to access and process the content within the paragraphs.

This record encapsulates metadata and content related to paragraphs, including comment metadata, a data iterator, a list of elements, an optional previous section break, and an indicator for whether there are an odd number of breaks.

  • Constructor Details

    • Paragraphs

      public Paragraphs(Comment comment, Iterator<Object> data, List<Object> elements, Optional<org.docx4j.wml.SectPr> previousSectionBreak, boolean oddNumberOfBreaks)
      Creates an instance of a Paragraphs record class.
      Parameters:
      comment - the value for the comment record component
      data - the value for the data record component
      elements - the value for the elements record component
      previousSectionBreak - the value for the previousSectionBreak record component
      oddNumberOfBreaks - the value for the oddNumberOfBreaks record component

  • Method Details

    • elements

      public <T> List<T> elements(Class<T> aClass)
      Filters and retrieves elements from the internal list that are instances of the specified class type.
      Type Parameters:
      T - the type of elements to be filtered and returned
      Parameters:
      aClass - the class type used to filter and retrieve elements
      Returns:
      a list of elements that are instances of the specified class type

    • 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.

    • comment

      public Comment comment()
      Returns the value of the comment record component.
      Returns:
      the value of the comment record component

    • data

      public Iterator<Object> data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component

    • elements

      public List<Object> elements()
      Returns the value of the elements record component.
      Returns:
      the value of the elements record component

    • previousSectionBreak

      public Optional<org.docx4j.wml.SectPr> previousSectionBreak()
      Returns the value of the previousSectionBreak record component.
      Returns:
      the value of the previousSectionBreak record component

    • oddNumberOfBreaks

      public boolean oddNumberOfBreaks()
      Returns the value of the oddNumberOfBreaks record component.
      Returns:
      the value of the oddNumberOfBreaks record component