Record Class ReportConfiguration.IODescriptor<T>

java.lang.Object
java.lang.Record
org.apache.rat.ReportConfiguration.IODescriptor<T>
Type Parameters:
T - either InputStream or OutputStream.
Record Components:
name - the name of the supplier.
ioSupplier - the IOSupplier that provides either an InputStream or an OutputStream.
Enclosing class:
ReportConfiguration
public static record ReportConfiguration.IODescriptor<T>(String name, org.apache.commons.io.function.IOSupplier<T> ioSupplier) extends Record
An IODescriptor comprises a name and an IOSupplier. The name should identify the contents of the stream.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IODescriptor(String name, org.apache.commons.io.function.IOSupplier<T> ioSupplier)
    Creates an instance of a IODescriptor record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    org.apache.commons.io.function.IOSupplier<T>
    ioSupplier()
    Returns the value of the ioSupplier record component.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • IODescriptor

      public IODescriptor(String name, org.apache.commons.io.function.IOSupplier<T> ioSupplier)
      Creates an instance of a IODescriptor record class.
      Parameters:
      name - the value for the name record component
      ioSupplier - the value for the ioSupplier 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.

    • name

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

    • ioSupplier

      public org.apache.commons.io.function.IOSupplier<T> ioSupplier()
      Returns the value of the ioSupplier record component.
      Returns:
      the value of the ioSupplier record component