Record Class CsvSupport.Quote

java.lang.Object
java.lang.Record
io.jenetics.ext.util.CsvSupport.Quote
Record Components:
value - the quote character
Enclosing class:
CsvSupport

public static record CsvSupport.Quote(char value) extends Record
Holds the CSV column quote character. The following excerpt from RFC-4180 defines when a quote character has to be used.
     5.  Each field may or may not be enclosed in double quotes (however
         some programs, such as Microsoft Excel, do not use double quotes
         at all).  If fields are not enclosed with double quotes, then
         double quotes may not appear inside the fields.  For example:

         "aaa","bbb","ccc" CRLF
         zzz,yyy,xxx

     6.  Fields containing line breaks (CRLF), double quotes, and commas
         should be enclosed in double-quotes.  For example:

         "aaa","b CRLF
         bb","ccc" CRLF
         zzz,yyy,xxx

     7.  If double-quotes are used to enclose fields, then a double-quote
         appearing inside a field must be escaped by preceding it with
         another double quote.  For example:

         "aaa","b""bb","ccc"
 
Since:
8.1
Version:
8.1
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final CsvSupport.Quote
    The default quote character, '"'.
    static final CsvSupport.Quote
    The zero '\0' character.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Quote(char value)
    Creates a new Quote char object.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    final String
    Returns a string representation of this record class.
    char
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

    • Quote

      public Quote(char value)
      Creates a new Quote char object.
      Parameters:
      value - the quote character
      Throws:
      IllegalArgumentException - if the given quote character is a line break character
  • 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 '=='.
      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.
    • value

      public char value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component