Package org.jweaver.crawler.internal.write

Record Class MarkdownExportConfig

java.lang.Object
java.lang.Record
org.jweaver.crawler.internal.write.MarkdownExportConfig
Record Components:
path - The export path of the generated files
All Implemented Interfaces:
ExportConfig
public record MarkdownExportConfig(String path) extends Record implements ExportConfig
The MarkdownExportConfig record represents the configuration for exporting data in Markdown format. It implements the ExportConfig interface and specifies the path where the exported files will be stored.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MarkdownExportConfig(String path)
    Creates an instance of a MarkdownExportConfig 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 Markdown for this configuration.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    metadata()
    Specifies whether metadata should be included in the export.
    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

    • MarkdownExportConfig

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

  • Method Details

    • format

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

    • metadata

      public boolean metadata()
      Specifies whether metadata should be included in the export. For Markdown export configuration, metadata is not included.
      Specified by:
      metadata in interface ExportConfig
      Returns:
      False, indicating that metadata is not included in the export.

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

    • 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