Package org.beanio.stream.delimited

Class DelimitedParserConfiguration

  • Direct Known Subclasses:
    DelimitedRecordParserFactory
    public class DelimitedParserConfiguration
extends java.lang.Object
    Stores configuration settings for parsing delimited formatted streams.
    Since:
    2.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String[] getComments()
      Returns the array of comment prefixes.
      char getDelimiter()
      Returns the field delimiting character.
      java.lang.Character getEscape()
      Returns the character used by the input stream to escape delimiters and itself.
      java.lang.Character getLineContinuationCharacter()
      Returns the line continuation character or null if line continuation is disabled.
      java.lang.String getRecordTerminator()
      Returns the character used to mark the end of a record.
      boolean isCommentEnabled()
      Returns whether one or more comment prefixes have been configured.
      boolean isEscapeEnabled()
      Returns whether an escape character is enabled.
      boolean isLineContinationEnabled()
      Returns whether the line continuation character is enabled.
      void setComments​(java.lang.String[] comments)
      Sets the array of comment prefixes.
      void setDelimiter​(char delimiter)
      Sets the field delimiting character to use.
      void setEscape​(java.lang.Character escapeCharacter)
      Sets the character used by the input stream to escape delimiters and itself.
      void setLineContinuationCharacter​(java.lang.Character lineContinuationCharacter)
      Sets the line continuation character.
      void setRecordTerminator​(java.lang.String recordTerminator)
      Sets the character used to mark the end of a record.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DelimitedParserConfiguration

        public DelimitedParserConfiguration()
        Constructs a new DelimitedParserConfiguration.

      • DelimitedParserConfiguration

        public DelimitedParserConfiguration​(char delimiter)
        Constructs a new DelimitedReaderConfiguration.
        Parameters:
        delimiter - the field delimiting character

    • Method Detail

      • getDelimiter

        public char getDelimiter()
        Returns the field delimiting character. Defaults to tab.
        Returns:
        the record delimiter

      • setDelimiter

        public void setDelimiter​(char delimiter)
        Sets the field delimiting character to use.
        Parameters:
        delimiter - the record delimiting character

      • getEscape

        public java.lang.Character getEscape()
        Returns the character used by the input stream to escape delimiters and itself. By default, escaping is disabled.
        Returns:
        the escape character or null if escaping is disabled

      • setEscape

        public void setEscape​(java.lang.Character escapeCharacter)
        Sets the character used by the input stream to escape delimiters and itself. If set to null, escaping is disabled.
        Parameters:
        escapeCharacter - the new escape character

      • getLineContinuationCharacter

        public java.lang.Character getLineContinuationCharacter()
        Returns the line continuation character or null if line continuation is disabled. By default, line continuation is disabled.
        Returns:
        the line continuation character or null if disabled

      • setLineContinuationCharacter

        public void setLineContinuationCharacter​(java.lang.Character lineContinuationCharacter)
        Sets the line continuation character. May be set to null to disable line continuation.
        Parameters:
        lineContinuationCharacter - the line continuation character

      • isEscapeEnabled

        public boolean isEscapeEnabled()
        Returns whether an escape character is enabled.
        Returns:
        true if enabled, false otherwise

      • isLineContinationEnabled

        public boolean isLineContinationEnabled()
        Returns whether the line continuation character is enabled.
        Returns:
        true if the line continuation character is enabled

      • getRecordTerminator

        public java.lang.String getRecordTerminator()
        Returns the character used to mark the end of a record. By default, a carriage return (CR), line feed (LF), or CRLF sequence is used to signify the end of the record.
        Returns:
        the record termination character

      • setRecordTerminator

        public void setRecordTerminator​(java.lang.String recordTerminator)
        Sets the character used to mark the end of a record. If set to null, a carriage return (CR), line feed (LF), or CRLF sequence is used.
        Parameters:
        recordTerminator - the record termination character

      • getComments

        public java.lang.String[] getComments()
        Returns the array of comment prefixes. If a line read from a stream begins with a configured comment prefix, the line is ignored. By default, no lines are considered commented.
        Returns:
        the array of comment prefixes

      • setComments

        public void setComments​(java.lang.String[] comments)
        Sets the array of comment prefixes. If a line read from a stream begins with a configured comment prefix, the line is ignored.
        Parameters:
        comments - the array of comment prefixes

      • isCommentEnabled

        public boolean isCommentEnabled()
        Returns whether one or more comment prefixes have been configured.
        Returns:
        true if one or more comment prefixes have been configured