Module io.github.mmm.scanner
Package io.github.mmm.scanner

Interface CharScannerSyntax

All Known Implementing Classes:
CharScannerSyntaxBean
public interface CharScannerSyntax
This is the interface used to define the syntax to scan characters.
See Also:

  • Method Details

    • getQuoteStart

      char getQuoteStart()
      This method gets the character used to start a quotation that should be terminated by a quote-end character. The text inside the quote is taken as is (without the quote characters).
      Common examples for quote characters are the single quotes (') and double quotes (").
      Returns:
      the character used to start a quotation or '\0' to disable.

    • getQuoteEnd

      char getQuoteEnd()
      This method gets the character used to end a quotation.
      Returns:
      the character used to end a quotation or '\0' to disable.
      See Also:

    • getEscape

      char getEscape()
      This method gets the character used as escape. It is used to mark special characters like getQuoteStart() to allow these characters also in the payload. The escape itself is removed on decoding while the next character is taken as is without any special interpretation.
      The most common escape character is the backslash (\).
      Here are some examples for decoding:
      escape input output
      \ a\b\\c ab\c
      ~ a~b~~~c ab~c
      This allows to encode special characters like a stop-character, quote-start, alt-quote-start, as well as the escape itself.
      ATTENTION:
      The escape is disabled within quotations.
      Returns:
      the escape character or '\0' for no escaping.
      See Also:

    • getQuoteEscape

      char getQuoteEscape()
      This method gets the character used to escape the quote-end character within a quotation. This may be the quote-end itself so a duplicate quote-end represents a single occurrence of that character within a quotation. Otherwise the escape may be any other character.
      Please note that this escaping is only active within a quotation opened by quote-start and only escapes the quote-end character and nothing else so in any other case the quote-escape is treated as a regular character.
      quote-start quote-end quote-escape input output
      ' ' ' a'bc'd abcd
      ' ' ' a'b''c'd ab'cd
      ' ' \ a'b\c\'d\\'e'f ab\c'd\'ef
      Returns:
      the character used to escape the quote-end character or '\0' to disable.

    • isQuoteEscapeLazy

      boolean isQuoteEscapeLazy()
      If quote-start, quote-end and quote-escape all point to the same character (which is NOT '\0'), then this method determines if quotation escaping is lazy. This means that outside a quotation a double occurrence of the quote character is NOT treated as quotation but as escaped quote character. Otherwise if NOT lazy, the double quote character is treated as quotation representing the empty sequence.
      Here are some examples:
      quote-start quote-end quote-escape quote-escape-lazy input output
      ' ' ' true '' '
      ' ' ' false ''  
      ' ' ' true '''' ''
      ' ' ' false '''' '
      ' ' ' true '''a' 'a
      ' ' ' false '''a' 'a

      Please note that for '''a' the complete sequence is treated as quote if quote-escape-lazy is false and otherwise just the trailing 'a'.
      Returns:
      true if quote-escaping is lazy, false otherwise.

    • getAltQuoteStart

      char getAltQuoteStart()
      This method gets the alternative character used to start a quotation that should be terminated by a alt-quote-end character. The text inside the quote is taken as is (without the quote characters).
      Returns:
      the alternative character used to start a quotation or '\0' to disable.
      See Also:

    • getAltQuoteEnd

      char getAltQuoteEnd()
      This method gets the alternative character used to end a quotation.
      Returns:
      the alternative character used to end a quotation.
      See Also:

    • getAltQuoteEscape

      char getAltQuoteEscape()
      This method gets the character used to escape the alt-quote-end character within an quotation opened by alt-quote-start.
      Returns:
      the character used to escape the quote-end character or '\0' to disable.
      See Also:

    • isAltQuoteEscapeLazy

      boolean isAltQuoteEscapeLazy()
      If alt-quote-start, alt-quote-end and alt-quote-escape all point to the same character (which is NOT '\0'), then this method determines if alt-quotation escaping is lazy.
      Returns:
      true if alt-quote-escaping is lazy, false otherwise.
      See Also:

    • getEntityStart

      char getEntityStart()
      This method gets the character used to start an entity. An entity is a specific encoded string surrounded with entity-start and entity-end. It will be decoded by resolveEntity(String).
      Returns:
      the character used to start an entity or '\0' to disable.

    • getEntityEnd

      char getEntityEnd()
      This method gets the character used to end an entity.
      Returns:
      the character used to end an entity.
      See Also:

    • resolveEntity

      String resolveEntity(String entity)
      This method resolves the given entity.
      E.g. if entity-start is '&' and getEntityEnd() is ';' then if the string "&lt;" is scanned, this method is called with "lt" as entity argument and may return "<".
      Parameters:
      entity - is the entity string that was found surrounded by entity-start and entity-end excluding these characters.
      Returns:
      the decoded entity.