Package de.eldoria.schematicsanitizer.sanitizer.report

Record Class SanitizerReport

java.lang.Object
java.lang.Record
de.eldoria.schematicsanitizer.sanitizer.report.SanitizerReport
Record Components:
newPath - the new path of the file if one was created
entities - the removed entities because of their type
blocks - the removed blocks because of their type
entitiesNbt - the removed entities because of their tags
blocksNbt - the removed blocks because of their tags
limits - the limits or the schematics
public record SanitizerReport(Path path, @Nullable Path newPath, EntityReport entities, BlockReport blocks, EntityNbtReport entitiesNbt, BlockNbtReport blocksNbt, LimitReport limits) extends Record
A report representing actions taken by a Sanitizer process.

  • Constructor Details

    • SanitizerReport

      public SanitizerReport(Path path, @Nullable @Nullable Path newPath, EntityReport entities, BlockReport blocks, EntityNbtReport entitiesNbt, BlockNbtReport blocksNbt, LimitReport limits)
      Creates an instance of a SanitizerReport record class.
      Parameters:
      path - the value for the path record component
      newPath - the value for the newPath record component
      entities - the value for the entities record component
      blocks - the value for the blocks record component
      entitiesNbt - the value for the entitiesNbt record component
      blocksNbt - the value for the blocksNbt record component
      limits - the value for the limits 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • path

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

    • newPath

      @Nullable public @Nullable Path newPath()
      Returns the value of the newPath record component.
      Returns:
      the value of the newPath record component

    • entities

      public EntityReport entities()
      Returns the value of the entities record component.
      Returns:
      the value of the entities record component

    • blocks

      public BlockReport blocks()
      Returns the value of the blocks record component.
      Returns:
      the value of the blocks record component

    • entitiesNbt

      public EntityNbtReport entitiesNbt()
      Returns the value of the entitiesNbt record component.
      Returns:
      the value of the entitiesNbt record component

    • blocksNbt

      public BlockNbtReport blocksNbt()
      Returns the value of the blocksNbt record component.
      Returns:
      the value of the blocksNbt record component

    • limits

      public LimitReport limits()
      Returns the value of the limits record component.
      Returns:
      the value of the limits record component