Package io.fluxzero.tools.jsondoclet.config

Record Class DocletConfiguration

java.lang.Object
java.lang.Record
io.fluxzero.tools.jsondoclet.config.DocletConfiguration
public record DocletConfiguration(Path outputDirectory, boolean prettyPrint, boolean includePrivate) extends Record
Immutable configuration for JSON doclet execution.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DocletConfiguration(Path outputDirectory, boolean prettyPrint, boolean includePrivate)
    Creates an instance of a DocletConfiguration 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.
    boolean
    includePrivate()
    Returns the value of the includePrivate record component.
    Path
    outputDirectory()
    Returns the value of the outputDirectory record component.
    boolean
    prettyPrint()
    Returns the value of the prettyPrint record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DocletConfiguration

      public DocletConfiguration(Path outputDirectory, boolean prettyPrint, boolean includePrivate)
      Creates an instance of a DocletConfiguration record class.
      Parameters:
      outputDirectory - the value for the outputDirectory record component
      prettyPrint - the value for the prettyPrint record component
      includePrivate - the value for the includePrivate 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 '=='.
      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.

    • outputDirectory

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

    • prettyPrint

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

    • includePrivate

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