Package org.apache.flink.table.client.cli.parser

Class SyntaxHighlightStyle

java.lang.Object
org.apache.flink.table.client.cli.parser.SyntaxHighlightStyle
public class SyntaxHighlightStyle extends Object
Styles for SqlClientSyntaxHighlighter.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    SyntaxHighlightStyle.BuiltInStyle
    Pre-defined highlight styles.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SyntaxHighlightStyle(org.jline.utils.AttributedStyle commentStyle, org.jline.utils.AttributedStyle hintStyle, org.jline.utils.AttributedStyle defaultStyle, org.jline.utils.AttributedStyle keywordStyle, org.jline.utils.AttributedStyle singleQuotedStyle, org.jline.utils.AttributedStyle sqlIdentifierStyle)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.jline.utils.AttributedStyle
    getCommentStyle()
    Returns the style for a SQL comments, such as /* This is a comment */ or -- End of line comment.
    org.jline.utils.AttributedStyle
    getDefaultStyle()
    Returns the style for text that does not match any other style.
    org.jline.utils.AttributedStyle
    getHintStyle()
    Returns the style for a SQL hint, such as /*+ This is a hint */.
    org.jline.utils.AttributedStyle
    getKeywordStyle()
    Returns the style for a SQL keyword such as SELECT or ON.
    org.jline.utils.AttributedStyle
    getQuotedStyle()
    Returns the style for a SQL character literal, such as 'Hello, world!'.
    org.jline.utils.AttributedStyle
    getSqlIdentifierStyle()
    Returns the style for a SQL identifier, such as `My_table` or `My table`.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SyntaxHighlightStyle

      public SyntaxHighlightStyle(org.jline.utils.AttributedStyle commentStyle, org.jline.utils.AttributedStyle hintStyle, org.jline.utils.AttributedStyle defaultStyle, org.jline.utils.AttributedStyle keywordStyle, org.jline.utils.AttributedStyle singleQuotedStyle, org.jline.utils.AttributedStyle sqlIdentifierStyle)

  • Method Details

    • getKeywordStyle

      public org.jline.utils.AttributedStyle getKeywordStyle()
      Returns the style for a SQL keyword such as SELECT or ON.
      Returns:
      Style for SQL keywords

    • getQuotedStyle

      public org.jline.utils.AttributedStyle getQuotedStyle()
      Returns the style for a SQL character literal, such as 'Hello, world!'.
      Returns:
      Style for SQL character literals

    • getSqlIdentifierStyle

      public org.jline.utils.AttributedStyle getSqlIdentifierStyle()
      Returns the style for a SQL identifier, such as `My_table` or `My table`.
      Returns:
      Style for SQL identifiers

    • getCommentStyle

      public org.jline.utils.AttributedStyle getCommentStyle()
      Returns the style for a SQL comments, such as /* This is a comment */ or -- End of line comment.
      Returns:
      Style for SQL comments

    • getHintStyle

      public org.jline.utils.AttributedStyle getHintStyle()
      Returns the style for a SQL hint, such as /*+ This is a hint */.
      Returns:
      Style for SQL hints

    • getDefaultStyle

      public org.jline.utils.AttributedStyle getDefaultStyle()
      Returns the style for text that does not match any other style.
      Returns:
      Default style