Record Class Packager.UnpackOutcome

java.lang.Object
java.lang.Record
org.ek9lang.core.Packager.UnpackOutcome
Enclosing class:
Packager

public static record Packager.UnpackOutcome(boolean success, Optional<String> offendingEntry, Optional<String> problem) extends Record
The outcome of Packager.unpack(File, File): it succeeded; or an entry was refused (zip-slip) and offendingEntry names it; or it failed part way and problem says why (a resource limit included).
  • Constructor Details

    • UnpackOutcome

      public UnpackOutcome(boolean success, Optional<String> offendingEntry, Optional<String> problem)
      Creates an instance of a UnpackOutcome record class.
      Parameters:
      success - the value for the success record component
      offendingEntry - the value for the offendingEntry record component
      problem - the value for the problem 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.
    • success

      public boolean success()
      Returns the value of the success record component.
      Returns:
      the value of the success record component
    • offendingEntry

      public Optional<String> offendingEntry()
      Returns the value of the offendingEntry record component.
      Returns:
      the value of the offendingEntry record component
    • problem

      public Optional<String> problem()
      Returns the value of the problem record component.
      Returns:
      the value of the problem record component