Package org.jweaver.crawler.internal.write

Record Class JsonExportConfig

java.lang.Object
java.lang.Record
org.jweaver.crawler.internal.write.JsonExportConfig
Record Components:
path - The export path of the generated files
metadata - Enable or disable metadata on the generated file
All Implemented Interfaces:
ExportConfig
public record JsonExportConfig(String path, boolean metadata) extends Record implements ExportConfig
The JsonExportConfig record represents the configuration for exporting data in JSON format. It implements the ExportConfig interface and specifies the path where the exported files will be stored, as well as whether metadata should be included in the export.

  • Constructor Summary

    Constructors
    Constructor
    Description
    JsonExportConfig(String path, boolean metadata)
    Creates an instance of a JsonExportConfig record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    ExportFileFormat
    format()
    Retrieves the export file format, which is JSON for this configuration.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    metadata()
    Returns the value of the metadata record component.
    String
    path()
    Returns the value of the path 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

    • JsonExportConfig

      public JsonExportConfig(String path, boolean metadata)
      Creates an instance of a JsonExportConfig record class.
      Parameters:
      path - the value for the path record component
      metadata - the value for the metadata record component

  • Method Details

    • format

      public ExportFileFormat format()
      Retrieves the export file format, which is JSON for this configuration.
      Specified by:
      format in interface ExportConfig
      Returns:
      The export file format, which is JSON.

    • 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.

    • path

      public String path()
      Returns the value of the path record component.
      Specified by:
      path in interface ExportConfig
      Returns:
      the value of the path record component

    • metadata

      public boolean metadata()
      Returns the value of the metadata record component.
      Specified by:
      metadata in interface ExportConfig
      Returns:
      the value of the metadata record component