Package edu.ie3.datamodel.io.csv

Record Class CsvFileDefinition

java.lang.Object
java.lang.Record
edu.ie3.datamodel.io.csv.CsvFileDefinition
public record CsvFileDefinition(String fileName, String directoryPath, String[] headLineElements, String csvSep) extends Record

  • Constructor Details

    • CsvFileDefinition

      public CsvFileDefinition(String fileName, String directoryPath, String[] headLineElements, String csvSep)
      Creates an instance of a CsvFileDefinition record class.
      Parameters:
      fileName - the value for the fileName record component
      directoryPath - the value for the directoryPath record component
      headLineElements - the value for the headLineElements record component
      csvSep - the value for the csvSep record component

  • Method Details

    • getDirectoryPath

      @Deprecated(since="3.0") public String getDirectoryPath()
      Deprecated.
      since 3.0. Use directoryPath() instead

    • getFileName

      @Deprecated(since="3.0") public String getFileName()
      Deprecated.
      since 3.0. Use fileName() instead
      Returns:
      The file name including extension

    • getFilePath

      public String getFilePath()
      Returns:
      The path to the file relative to a not explicitly defined base directory, including the file extension

    • getHeadLineElements

      @Deprecated(since="3.0") public String[] getHeadLineElements()
      Deprecated.
      since 3.0. Use headLineElements() instead

    • getCsvSep

      @Deprecated(since="3.0") public String getCsvSep()
      Deprecated.
      since 3.0. Use csvSep() instead

    • equals

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

    • hashCode

      public 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

    • toString

      public 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

    • fileName

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

    • directoryPath

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

    • headLineElements

      public String[] headLineElements()
      Returns the value of the headLineElements record component.
      Returns:
      the value of the headLineElements record component

    • csvSep

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