java.lang.Object

java.lang.Enum<BuiltInProperty>

sqlline.BuiltInProperty

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<BuiltInProperty>, java.lang.constant.Constable, SqlLineProperty

public enum BuiltInProperty
extends java.lang.Enum<BuiltInProperty>
implements SqlLineProperty

Built-in properties of SqlLine.

Every property must implement the SqlLineProperty interface; it is convenient to put properties in this enum but not mandatory.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum
java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

Nested classes/interfaces inherited from interface sqlline.SqlLineProperty
SqlLineProperty.Type, SqlLineProperty.Writer

Enum Constant Summary

Enum Constants
Enum Constant	Description
`AUTO_COMMIT`
`AUTO_PAIRING`
`AUTO_RESIZE`
`AUTO_SAVE`
`COLOR`
`COLOR_SCHEME`
`CONFIRM`
`CONFIRM_PATTERN`
`CONNECT_INTERACTION_MODE`
`CONNECTION_CONFIG`
`CSV_DELIMITER`
`CSV_QUOTE_CHARACTER`
`DATE_FORMAT`
`ESCAPE_OUTPUT`
`FAST_CONNECT`
`FORCE`
`HEADER_INTERVAL`
`HISTORY_FILE`
`HISTORY_FLAGS`
`INCREMENTAL`
`INCREMENTAL_BUFFER_ROWS`
`ISOLATION`
`KEEP_SEMICOLON`
`LIVE_TEMPLATES`
`MAX_COLUMN_WIDTH`
`MAX_HEIGHT`
`MAX_HISTORY_FILE_ROWS`
`MAX_HISTORY_ROWS`
`MAX_WIDTH`
`MODE`
`NULL_VALUE`
`NUMBER_FORMAT`
`OUTPUT_FORMAT`
`PROMPT`
`PROMPT_SCRIPT`
`PROPERTIES_FILE`
`READ_ONLY`
`RIGHT_PROMPT`
`ROW_LIMIT`
`SCRIPT_ENGINE`
`SHOW_COMPLETION_DESCR`
`SHOW_ELAPSED_TIME`
`SHOW_HEADER`
`SHOW_LINE_NUMBERS`
`SHOW_NESTED_ERRS`
`SHOW_TYPES`
`SHOW_WARNINGS`
`SILENT`
`STRICT_JDBC`
`TABLE_STYLE`
`TIME_FORMAT`
`TIMEOUT`
`TIMESTAMP_FORMAT`
`TRIM_SCRIPTS`
`USE_LINE_CONTINUATION`
`VERBOSE`
`VERSION`

Field Summary

Fields inherited from interface sqlline.SqlLineProperty
BOOLEAN_VALUES, DEFAULT

Method Summary

Modifier and Type	Method	Description
`boolean`	`couldBeStored()`
`java.lang.Object`	`defaultValue()`
`java.util.Set<java.lang.String>`	`getAvailableValues()`
`boolean`	`isReadOnly()`
`java.lang.String`	`propertyName()`
`SqlLineProperty.Type`	`type()`
`static BuiltInProperty`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static SqlLineProperty`	`valueOf(java.lang.String propertyName, boolean ignoreCase)`	Returns the built-in property with the given name, or null if not found.
`static BuiltInProperty[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details
- AUTO_COMMIT
  
  public static final BuiltInProperty AUTO_COMMIT
- AUTO_PAIRING
  
  public static final BuiltInProperty AUTO_PAIRING
- AUTO_RESIZE
  
  public static final BuiltInProperty AUTO_RESIZE
- AUTO_SAVE
  
  public static final BuiltInProperty AUTO_SAVE
- COLOR_SCHEME
  
  public static final BuiltInProperty COLOR_SCHEME
- COLOR
  
  public static final BuiltInProperty COLOR
- CONFIRM
  
  public static final BuiltInProperty CONFIRM
- CONFIRM_PATTERN
  
  public static final BuiltInProperty CONFIRM_PATTERN
- CONNECT_INTERACTION_MODE
  
  public static final BuiltInProperty CONNECT_INTERACTION_MODE
- CONNECTION_CONFIG
  
  public static final BuiltInProperty CONNECTION_CONFIG
- CSV_DELIMITER
  
  public static final BuiltInProperty CSV_DELIMITER
- CSV_QUOTE_CHARACTER
  
  public static final BuiltInProperty CSV_QUOTE_CHARACTER
- DATE_FORMAT
  
  public static final BuiltInProperty DATE_FORMAT
- ESCAPE_OUTPUT
  
  public static final BuiltInProperty ESCAPE_OUTPUT
- FAST_CONNECT
  
  public static final BuiltInProperty FAST_CONNECT
- FORCE
  
  public static final BuiltInProperty FORCE
- HEADER_INTERVAL
  
  public static final BuiltInProperty HEADER_INTERVAL
- HISTORY_FILE
  
  public static final BuiltInProperty HISTORY_FILE
- HISTORY_FLAGS
  
  public static final BuiltInProperty HISTORY_FLAGS
- INCREMENTAL
  
  public static final BuiltInProperty INCREMENTAL
- INCREMENTAL_BUFFER_ROWS
  
  public static final BuiltInProperty INCREMENTAL_BUFFER_ROWS
- ISOLATION
  
  public static final BuiltInProperty ISOLATION
- KEEP_SEMICOLON
  
  public static final BuiltInProperty KEEP_SEMICOLON
- LIVE_TEMPLATES
  
  public static final BuiltInProperty LIVE_TEMPLATES
- MAX_COLUMN_WIDTH
  
  public static final BuiltInProperty MAX_COLUMN_WIDTH
- MAX_HEIGHT
  
  public static final BuiltInProperty MAX_HEIGHT
- MAX_WIDTH
  
  public static final BuiltInProperty MAX_WIDTH
- MAX_HISTORY_ROWS
  
  public static final BuiltInProperty MAX_HISTORY_ROWS
- MAX_HISTORY_FILE_ROWS
  
  public static final BuiltInProperty MAX_HISTORY_FILE_ROWS
- MODE
  
  public static final BuiltInProperty MODE
- NUMBER_FORMAT
  
  public static final BuiltInProperty NUMBER_FORMAT
- NULL_VALUE
  
  public static final BuiltInProperty NULL_VALUE
- SILENT
  
  public static final BuiltInProperty SILENT
- OUTPUT_FORMAT
  
  public static final BuiltInProperty OUTPUT_FORMAT
- TABLE_STYLE
  
  public static final BuiltInProperty TABLE_STYLE
- PROMPT
  
  public static final BuiltInProperty PROMPT
- PROMPT_SCRIPT
  
  public static final BuiltInProperty PROMPT_SCRIPT
- PROPERTIES_FILE
  
  public static final BuiltInProperty PROPERTIES_FILE
- READ_ONLY
  
  public static final BuiltInProperty READ_ONLY
- RIGHT_PROMPT
  
  public static final BuiltInProperty RIGHT_PROMPT
- ROW_LIMIT
  
  public static final BuiltInProperty ROW_LIMIT
- SHOW_ELAPSED_TIME
  
  public static final BuiltInProperty SHOW_ELAPSED_TIME
- SCRIPT_ENGINE
  
  public static final BuiltInProperty SCRIPT_ENGINE
- SHOW_COMPLETION_DESCR
  
  public static final BuiltInProperty SHOW_COMPLETION_DESCR
- SHOW_HEADER
  
  public static final BuiltInProperty SHOW_HEADER
- SHOW_LINE_NUMBERS
  
  public static final BuiltInProperty SHOW_LINE_NUMBERS
- SHOW_NESTED_ERRS
  
  public static final BuiltInProperty SHOW_NESTED_ERRS
- SHOW_TYPES
  
  public static final BuiltInProperty SHOW_TYPES
- SHOW_WARNINGS
  
  public static final BuiltInProperty SHOW_WARNINGS
- STRICT_JDBC
  
  public static final BuiltInProperty STRICT_JDBC
- TIME_FORMAT
  
  public static final BuiltInProperty TIME_FORMAT
- TIMEOUT
  
  public static final BuiltInProperty TIMEOUT
- TIMESTAMP_FORMAT
  
  public static final BuiltInProperty TIMESTAMP_FORMAT
- TRIM_SCRIPTS
  
  public static final BuiltInProperty TRIM_SCRIPTS
- USE_LINE_CONTINUATION
  
  public static final BuiltInProperty USE_LINE_CONTINUATION
- VERBOSE
  
  public static final BuiltInProperty VERBOSE
- VERSION
  
  public static final BuiltInProperty VERSION
Method Details
- values
  
  public static BuiltInProperty[] values()
  
  Returns an array containing the constants of this enum type, in the order they are declared.
  
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
  
  public static BuiltInProperty valueOf(java.lang.String name)
  
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
  
  Parameters:
  
  name - the name of the enum constant to be returned.
  
  Returns:
  
  the enum constant with the specified name
  
  Throws:
  
  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
  
  java.lang.NullPointerException - if the argument is null
- propertyName
  
  public java.lang.String propertyName()
  
  Specified by:
  
  propertyName in interface SqlLineProperty
- defaultValue
  
  public java.lang.Object defaultValue()
  
  Specified by:
  
  defaultValue in interface SqlLineProperty
- isReadOnly
  
  public boolean isReadOnly()
  
  Specified by:
  
  isReadOnly in interface SqlLineProperty
- couldBeStored
  
  public boolean couldBeStored()
  
  Specified by:
  
  couldBeStored in interface SqlLineProperty
- type
  
  public SqlLineProperty.Type type()
  
  Specified by:
  
  type in interface SqlLineProperty
- getAvailableValues
  
  public java.util.Set<java.lang.String> getAvailableValues()
  
  Specified by:
  
  getAvailableValues in interface SqlLineProperty
- valueOf
  
  public static SqlLineProperty valueOf(java.lang.String propertyName, boolean ignoreCase)
  
  Returns the built-in property with the given name, or null if not found.
  
  Parameters:
  
  propertyName - Property name
  
  ignoreCase - Whether to ignore case
  
  Returns:
  
  Property, or null if not found

Enum BuiltInProperty

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Nested classes/interfaces inherited from interface sqlline.SqlLineProperty

Enum Constant Summary

Field Summary

Fields inherited from interface sqlline.SqlLineProperty

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Details

Method Details