Package com.github.joschi.jadconfig.documentation

Record Class DocumentationFormat

java.lang.Object
java.lang.Record
com.github.joschi.jadconfig.documentation.DocumentationFormat
public record DocumentationFormat(String format, String outputFile) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    DocumentationFormat(String format, String outputFile)
    Creates an instance of a DocumentationFormat record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    format()
    Returns the value of the format record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    outputFile()
    Returns the value of the outputFile record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • DocumentationFormat

      public DocumentationFormat(String format, String outputFile)
      Creates an instance of a DocumentationFormat record class.
      Parameters:
      format - the value for the format record component
      outputFile - the value for the outputFile 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.

    • format

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

    • outputFile

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