Record Class SourceGeneratorConfig.JavadocConfig

java.lang.Object
java.lang.Record
io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig.JavadocConfig
Record Components:
replaceHTML - Whether to replace HTML characters, e.g. > to >.
Enclosing class:
SourceGeneratorConfig
public static record SourceGeneratorConfig.JavadocConfig(boolean replaceHTML) extends Record
A sub-configuration used for generated Javadoc. The configuration has single parameter, but is expected to be extended with more properties.
Author:
Elif Kurtay

  • Constructor Summary

    Constructors
    Constructor
    Description
    JavadocConfig()
    Initialize the configuration with defaults.
    JavadocConfig(boolean replaceHTML)
    Creates an instance of a JavadocConfig 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
    replaceHTML()
    Returns the value of the replaceHTML 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

    • JavadocConfig

      public JavadocConfig()
      Initialize the configuration with defaults.

    • JavadocConfig

      public JavadocConfig(boolean replaceHTML)
      Creates an instance of a JavadocConfig record class.
      Parameters:
      replaceHTML - the value for the replaceHTML 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 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.

    • replaceHTML

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