Package com.inductiveautomation.ignition.common.util.csv

Class CSVParser

java.lang.Object
com.inductiveautomation.ignition.common.util.csv.CSVParser
public class CSVParser extends Object
A very simple CSV parser released under a commercial-friendly license. This just implements splitting a single line into fields.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final char
    DEFAULT_ESCAPE_CHARACTER
    The default escape character to use if none is supplied to the constructor.
    static final boolean
    DEFAULT_IGNORE_LEADING_WHITESPACE
    The default leading whitespace behavior to use if none is supplied to the constructor
    static final char
    DEFAULT_QUOTE_CHARACTER
    The default quote character to use if none is supplied to the constructor.
    static final char
    DEFAULT_SEPARATOR
    The default separator to use if none is supplied to the constructor.
    static final boolean
    DEFAULT_STRICT_QUOTES
    The default strict quote behavior to use if none is supplied to the constructor
    static final int
    INITIAL_READ_SIZE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CSVParser()
    Constructs CSVParser using a comma for the separator.
    CSVParser(char separator)
    Constructs CSVParser with supplied separator.
    CSVParser(char separator, char quotechar)
    Constructs CSVParser with supplied separator and quote char.
    CSVParser(char separator, char quotechar, char escape)
    Constructs CSVReader with supplied separator and quote char.
    CSVParser(char separator, char quotechar, char escape, boolean strictQuotes)
    Constructs CSVReader with supplied separator and quote char.
    CSVParser(char separator, char quotechar, char escape, boolean strictQuotes, boolean ignoreLeadingWhiteSpace)
    Constructs CSVReader with supplied separator and quote char.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    isAllWhiteSpace(CharSequence sb)
    precondition: sb.length() > 0
    protected boolean
    isNextCharacterEscapable(String nextLine, boolean inQuotes, int i)
    precondition: the current character is an escape
    boolean
    isPending()
     
    String[]
    parseLine(String nextLine)
     
    String[]
    parseLineMulti(String nextLine)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • DEFAULT_SEPARATOR

      public static final char DEFAULT_SEPARATOR
      The default separator to use if none is supplied to the constructor.
      See Also:

    • INITIAL_READ_SIZE

      public static final int INITIAL_READ_SIZE
      See Also:

    • DEFAULT_QUOTE_CHARACTER

      public static final char DEFAULT_QUOTE_CHARACTER
      The default quote character to use if none is supplied to the constructor.
      See Also:

    • DEFAULT_ESCAPE_CHARACTER

      public static final char DEFAULT_ESCAPE_CHARACTER
      The default escape character to use if none is supplied to the constructor.
      See Also:

    • DEFAULT_STRICT_QUOTES

      public static final boolean DEFAULT_STRICT_QUOTES
      The default strict quote behavior to use if none is supplied to the constructor
      See Also:

    • DEFAULT_IGNORE_LEADING_WHITESPACE

      public static final boolean DEFAULT_IGNORE_LEADING_WHITESPACE
      The default leading whitespace behavior to use if none is supplied to the constructor
      See Also:

  • Constructor Details

    • CSVParser

      public CSVParser()
      Constructs CSVParser using a comma for the separator.

    • CSVParser

      public CSVParser(char separator)
      Constructs CSVParser with supplied separator.
      Parameters:
      separator - the delimiter to use for separating entries.

    • CSVParser

      public CSVParser(char separator, char quotechar)
      Constructs CSVParser with supplied separator and quote char.
      Parameters:
      separator - the delimiter to use for separating entries
      quotechar - the character to use for quoted elements

    • CSVParser

      public CSVParser(char separator, char quotechar, char escape)
      Constructs CSVReader with supplied separator and quote char.
      Parameters:
      separator - the delimiter to use for separating entries
      quotechar - the character to use for quoted elements
      escape - the character to use for escaping a separator or quote

    • CSVParser

      public CSVParser(char separator, char quotechar, char escape, boolean strictQuotes)
      Constructs CSVReader with supplied separator and quote char. Allows setting the "strict quotes" flag
      Parameters:
      separator - the delimiter to use for separating entries
      quotechar - the character to use for quoted elements
      escape - the character to use for escaping a separator or quote
      strictQuotes - if true, characters outside the quotes are ignored

    • CSVParser

      public CSVParser(char separator, char quotechar, char escape, boolean strictQuotes, boolean ignoreLeadingWhiteSpace)
      Constructs CSVReader with supplied separator and quote char. Allows setting the "strict quotes" and "ignore leading whitespace" flags
      Parameters:
      separator - the delimiter to use for separating entries
      quotechar - the character to use for quoted elements
      escape - the character to use for escaping a separator or quote
      strictQuotes - if true, characters outside the quotes are ignored
      ignoreLeadingWhiteSpace - if true, white space in front of a quote in a field is ignored

  • Method Details

    • isPending

      public boolean isPending()
      Returns:
      true if something was left over from last call(s)

    • parseLineMulti

      public String[] parseLineMulti(String nextLine) throws IOException
      Throws:
      IOException

    • parseLine

      public String[] parseLine(String nextLine) throws IOException
      Throws:
      IOException

    • isNextCharacterEscapable

      protected boolean isNextCharacterEscapable(String nextLine, boolean inQuotes, int i)
      precondition: the current character is an escape
      Parameters:
      nextLine - the current line
      inQuotes - true if the current context is quoted
      i - current index in line
      Returns:
      true if the following character is a quote

    • isAllWhiteSpace

      protected boolean isAllWhiteSpace(CharSequence sb)
      precondition: sb.length() > 0
      Parameters:
      sb - A sequence of characters to examine
      Returns:
      true if every character in the sequence is whitespace