Package io.jenkins.plugins.xmleditor.steps

Record Class EditRequest

java.lang.Object
java.lang.Record
io.jenkins.plugins.xmleditor.steps.EditRequest
All Implemented Interfaces:
Serializable
public record EditRequest(String file, String files, String excludes, String outputFile, long maxBytes, List<XmlOperation> operations, XPathOptions options, boolean showDiff, boolean dryRun) extends Record implements Serializable
An edit of workspace files: one file or all files matching files (Ant patterns, comma separated) minus excludes.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    EditRequest(String file, String files, String excludes, String outputFile, long maxBytes, List<XmlOperation> operations, XPathOptions options, boolean showDiff, boolean dryRun)
    Creates an instance of a EditRequest record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    dryRun()
    Returns the value of the dryRun record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    excludes()
    Returns the value of the excludes record component.
    String
    file()
    Returns the value of the file record component.
    String
    files()
    Returns the value of the files record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    maxBytes()
    Returns the value of the maxBytes record component.
    List<XmlOperation>
    operations()
    Returns the value of the operations record component.
    XPathOptions
    options()
    Returns the value of the options record component.
    String
    outputFile()
    Returns the value of the outputFile record component.
    boolean
    showDiff()
    Returns the value of the showDiff record component.
    final String
    toString()
    Returns a string representation of this record class.
    void
    validate()
    Rejects invalid parameter combinations with a clear message.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • EditRequest

      public EditRequest(String file, String files, String excludes, String outputFile, long maxBytes, List<XmlOperation> operations, XPathOptions options, boolean showDiff, boolean dryRun)
      Creates an instance of a EditRequest record class.
      Parameters:
      file - the value for the file record component
      files - the value for the files record component
      excludes - the value for the excludes record component
      outputFile - the value for the outputFile record component
      maxBytes - the value for the maxBytes record component
      operations - the value for the operations record component
      options - the value for the options record component
      showDiff - the value for the showDiff record component
      dryRun - the value for the dryRun record component

  • Method Details

    • validate

      public void validate() throws AbortException
      Rejects invalid parameter combinations with a clear message.
      Throws:
      AbortException

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

    • file

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

    • files

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

    • excludes

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

    • outputFile

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

    • maxBytes

      public long maxBytes()
      Returns the value of the maxBytes record component.
      Returns:
      the value of the maxBytes record component

    • operations

      public List<XmlOperation> operations()
      Returns the value of the operations record component.
      Returns:
      the value of the operations record component

    • options

      public XPathOptions options()
      Returns the value of the options record component.
      Returns:
      the value of the options record component

    • showDiff

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

    • dryRun

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