net.tixxit.delimited

DelimitedFormat

case class DelimitedFormat(separator: String, quote: String = "\"", quoteEscape: String = "\"", rowDelim: RowDelim = RowDelim.Both, allowRowDelimInQuotes: Boolean = true) extends DelimitedFormatStrategy with Product with Serializable

A DelimitedFormatStrategy where all parameters have been completely fixed.

separator

the delimiter that separates fields within a row

quote

the character/string that indicates the beginning/end of a quoted value

quoteEscape

the string that is used to escape a quote character, within a quoted value

rowDelim

the delimiter used to separate rows

allowRowDelimInQuotes

if true, allow row delimiters within quotes, otherwise they are treated as an error

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DelimitedFormat
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DelimitedFormatStrategy
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DelimitedFormat(separator: String, quote: String = "\"", quoteEscape: String = "\"", rowDelim: RowDelim = RowDelim.Both, allowRowDelimInQuotes: Boolean = true)

    separator

    the delimiter that separates fields within a row

    quote

    the character/string that indicates the beginning/end of a quoted value

    quoteEscape

    the string that is used to escape a quote character, within a quoted value

    rowDelim

    the delimiter used to separate rows

    allowRowDelimInQuotes

    if true, allow row delimiters within quotes, otherwise they are treated as an error

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. val allowRowDelimInQuotes: Boolean

    if true, allow row delimiters within quotes, otherwise they are treated as an error

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  10. def escape(text: String): String

    Escapes all quotes.

  11. val escapedQuote: String

    Returns an escaped quote that can be used to represent a literal quote within a quoted value.

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  18. val quote: String

    the character/string that indicates the beginning/end of a quoted value

  19. val quoteEscape: String

    the string that is used to escape a quote character, within a quoted value

  20. def render(text: String): String

    Renders a single cell of data, quoting and escaping the value if necessary.

    Renders a single cell of data, quoting and escaping the value if necessary. A cell is quoted and escaped if it contains a row delimiter, the separator, or a quote.

  21. val rowDelim: RowDelim

    the delimiter used to separate rows

  22. val separator: String

    the delimiter that separates fields within a row

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  24. def toString(): String

    Definition Classes
    DelimitedFormat → AnyRef → Any
  25. def unescape(value: String): String

    Replaces all escaped quoted in a quoted value with literal quotes

  26. def unquote(text: String): String

    If text starts with a quote, then this removes the wrapping quotes, then unescapes the resulting text.

    If text starts with a quote, then this removes the wrapping quotes, then unescapes the resulting text. If text does not start with a quote, then it is returned unchanged.

    This is the opposite of render.

  27. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def withQuote(quote: String): DelimitedFormat

  31. def withQuoteEscape(quoteEscape: String): DelimitedFormat

  32. def withRowDelim(rowDelim: String): DelimitedFormat

  33. def withRowDelim(rowDelim: RowDelim): DelimitedFormat

  34. def withRowDelimInQuotes(allowRowDelimInQuotes: Boolean): DelimitedFormat

  35. def withSeparator(separator: String): DelimitedFormat

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DelimitedFormatStrategy

Inherited from AnyRef

Inherited from Any

Ungrouped