Class/Object

net.tixxit.delimited

DelimitedFormat

Related Docs: object DelimitedFormat | package delimited

Permalink

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
Serializable, Serializable, Product, Equals, DelimitedFormatStrategy, AnyRef, Any
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
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    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: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. val allowRowDelimInQuotes: Boolean

    Permalink

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

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  8. def escape(text: String): String

    Permalink

    Escapes all quotes.

  9. val escapedQuote: String

    Permalink

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

  10. def finalize(): Unit

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

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

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

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. val quote: String

    Permalink

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

  17. val quoteEscape: String

    Permalink

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

  18. def render(text: String): String

    Permalink

    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.

  19. val rowDelim: RowDelim

    Permalink

    the delimiter used to separate rows

  20. val separator: String

    Permalink

    the delimiter that separates fields within a row

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

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

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

    Permalink

    Replaces all escaped quoted in a quoted value with literal quotes

  24. def unquote(text: String): String

    Permalink

    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.

  25. final def wait(): Unit

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

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

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

    Permalink
  29. def withQuoteEscape(quoteEscape: String): DelimitedFormat

    Permalink
  30. def withRowDelim(rowDelim: String): DelimitedFormat

    Permalink
  31. def withRowDelim(rowDelim: RowDelim): DelimitedFormat

    Permalink
  32. def withRowDelimInQuotes(allowRowDelimInQuotes: Boolean): DelimitedFormat

    Permalink
  33. def withSeparator(separator: String): DelimitedFormat

    Permalink

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DelimitedFormatStrategy

Inherited from AnyRef

Inherited from Any

Ungrouped