Package io.jenkins.plugins.xmleditor.core.edit

Record Class EditResult

java.lang.Object
java.lang.Record
io.jenkins.plugins.xmleditor.core.edit.EditResult
Record Components:
before - serialized document before the operations
after - serialized document after the operations
warnings - namespace warnings found while evaluating XPath
public record EditResult(boolean changed, List<OperationReport> reports, String before, String after, List<String> warnings) extends Record
Outcome of XmlEditor.apply(io.jenkins.plugins.xmleditor.core.model.LDocument, java.util.List<? extends io.jenkins.plugins.xmleditor.core.edit.XmlOperation>, io.jenkins.plugins.xmleditor.core.xpath.XPathOptions).

  • Constructor Details

    • EditResult

      public EditResult(boolean changed, List<OperationReport> reports, String before, String after, List<String> warnings)
      Creates an instance of a EditResult record class.
      Parameters:
      changed - the value for the changed record component
      reports - the value for the reports record component
      before - the value for the before record component
      after - the value for the after record component
      warnings - the value for the warnings 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 '=='.
      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.

    • changed

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

    • reports

      public List<OperationReport> reports()
      Returns the value of the reports record component.
      Returns:
      the value of the reports record component

    • before

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

    • after

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

    • warnings

      public List<String> warnings()
      Returns the value of the warnings record component.
      Returns:
      the value of the warnings record component