ColumnEditor (Debezium Core 0.7.2 API)

All Superinterfaces:

Comparable<Column>

All Known Implementing Classes:

ColumnEditorImpl
```
@NotThreadSafe
public interface ColumnEditor
extends Comparable<Column>
```
An editor for Column instances.

Author:

Randall Hauch

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ColumnEditor`	`autoIncremented(boolean autoIncremented)` Set whether the column's values are automatically incremented.
`String`	`charsetName()` Get the database-specific name of the character set used by this column.
`ColumnEditor`	`charsetName(String charsetName)` Set the database-specific name of the character set used by this column.
`String`	`charsetNameOfTable()` Get the database-specific name of the character set defined by this column's table, which is used if a character set is not explicitly set on this column.
`ColumnEditor`	`charsetNameOfTable(String charsetName)` Set the database-specific name of the character set defined by this column's table.
`int`	`componentType()` Get the underlying type for this column where jdbcType() itself is the generic Types.ARRAY (and in future Types.STRUCT).
`ColumnEditor`	`componentType(int componentType)` Set the component type for this column where jdbcType().
`Column`	`create()` Obtain an immutable column definition representing the current state of this editor.
`ColumnEditor`	`generated(boolean generated)` Set whether the column's values are generated by the database.
`boolean`	`isAutoIncremented()` Determine whether this column's values are automatically incremented by the database.
`boolean`	`isGenerated()` Determine whether this column's values are generated by the database.
`boolean`	`isOptional()` Determine whether this column is optional.
`int`	`jdbcType()` Get the `JDBC type` for this column
`ColumnEditor`	`jdbcType(int jdbcType)` Set the `JDBC type` of this column.
`int`	`length()` Get the maximum length of this column's values.
`ColumnEditor`	`length(int length)` Set the maximum length of this column's values.
`String`	`name()` Get the name of the column.
`ColumnEditor`	`name(String name)` Set the name of the column.
`ColumnEditor`	`optional(boolean optional)` Set whether the column's values are optional (e.g., can contain nulls).
`int`	`position()` Get the position of the column in the table.
`ColumnEditor`	`position(int position)` Set the position of the column within the table definition.
`int`	`scale()` Get the scale of the column.
`ColumnEditor`	`scale(int scale)` Set the scale of the column.
`ColumnEditor`	`type(String typeName)` Set the database-specific name of the column's data type.
`ColumnEditor`	`type(String typeName, String typeExpression)` Set the database-specific name of the column's data type.
`String`	`typeExpression()` Get the database-specific complete expression defining the column's data type, including dimensions, length, precision, character sets, constraints, etc.
`String`	`typeName()` Get the database-specific name of the column's data type.

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - name
```
String name()
```
    Get the name of the column.
    
    Returns:
    
    the column name; may be null if not set
  - position
```
int position()
```
    Get the position of the column in the table.
    
    Returns:
    
    the 1-based position
  - jdbcType
```
int jdbcType()
```
    Get the JDBC type for this column
    
    Returns:
    
    the type constant
  - componentType
```
int componentType()
```
    Get the underlying type for this column where jdbcType() itself is the generic Types.ARRAY (and in future Types.STRUCT). If there is no underlying type information then the value is unset.
    
    Returns:
    
    a type constant for the specific database, or -1 if not set.
  - typeName
```
String typeName()
```
    Get the database-specific name of the column's data type.
    
    Returns:
    
    the name of the type; may be null if not set
  - typeExpression
```
String typeExpression()
```
    Get the database-specific complete expression defining the column's data type, including dimensions, length, precision, character sets, constraints, etc.
    
    Returns:
    
    the complete type expression
  - charsetName
```
String charsetName()
```
    Get the database-specific name of the character set used by this column.
    
    Returns:
    
    the database-specific character set name, or null if the column's data type doesn't use character sets or no character set is specified
  - charsetNameOfTable
```
String charsetNameOfTable()
```
    Get the database-specific name of the character set defined by this column's table, which is used if a character set is not explicitly set on this column.
    
    Returns:
    
    the database-specific character set name defined for this column's table, or null if not defined
  - length
```
int length()
```
    Get the maximum length of this column's values. For numeric columns, this represents the precision.
    
    Returns:
    
    the length of the column
  - scale
```
int scale()
```
    Get the scale of the column.
    
    Returns:
    
    the scale, or -1 if the scale does not apply to this type
  - isOptional
```
boolean isOptional()
```
    Determine whether this column is optional.
    
    Returns:
    
    true if it is optional, or false otherwise
  - isAutoIncremented
```
boolean isAutoIncremented()
```
    Determine whether this column's values are automatically incremented by the database.
    
    Returns:
    
    true if the values are auto-incremented, or false otherwise
  - isGenerated
```
boolean isGenerated()
```
    Determine whether this column's values are generated by the database.
    
    Returns:
    
    true if the values are generated, or false otherwise
  - name
```
ColumnEditor name(String name)
```
    Set the name of the column.
    
    Parameters:
    
    name - the column name
    
    Returns:
    
    this editor so callers can chain methods together
  - type
```
ColumnEditor type(String typeName)
```
    Set the database-specific name of the column's data type.
    
    Parameters:
    
    typeName - the column's type name
    
    Returns:
    
    this editor so callers can chain methods together
  - type
```
ColumnEditor type(String typeName,
                  String typeExpression)
```
    Set the database-specific name of the column's data type. The expression includes the column's type name and also any dimensions, lengths, precisions, character sets, etc.
    
    Parameters:
    
    typeName - the column's type name
    
    typeExpression - the column's complete type expression
    
    Returns:
    
    this editor so callers can chain methods together
  - jdbcType
```
ColumnEditor jdbcType(int jdbcType)
```
    Set the JDBC type of this column.
    
    Parameters:
    
    jdbcType - JDBC type for this column
    
    Returns:
    
    this editor so callers can chain methods together
  - componentType
```
ColumnEditor componentType(int componentType)
```
    Set the component type for this column where jdbcType(). This is database specific and can be any integer value that relays additional information about the column-type since some jdbcTypes return generic type information (such as Types.ARRAY) that is not enough to understand the underlying column type.
    
    Returns:
    
    a type constant for the specific database, or -1 if there is no underlying type set
  - charsetName
```
ColumnEditor charsetName(String charsetName)
```
    Set the database-specific name of the character set used by this column.
    
    Parameters:
    
    charsetName - the database-specific character set name; may be null
    
    Returns:
    
    this editor so callers can chain methods together
  - charsetNameOfTable
```
ColumnEditor charsetNameOfTable(String charsetName)
```
    Set the database-specific name of the character set defined by this column's table.
    
    Parameters:
    
    charsetName - the database-specific character set name; may be null
    
    Returns:
    
    this editor so callers can chain methods together
  - length
```
ColumnEditor length(int length)
```
    Set the maximum length of this column's values. For numeric columns, this represents the precision.
    
    Parameters:
    
    length - the column's length
    
    Returns:
    
    this editor so callers can chain methods together
  - scale
```
ColumnEditor scale(int scale)
```
    Set the scale of the column.
    
    Parameters:
    
    scale - the scale, or -1 if the scale does not apply to this type
    
    Returns:
    
    this editor so callers can chain methods together
  - optional
```
ColumnEditor optional(boolean optional)
```
    Set whether the column's values are optional (e.g., can contain nulls).
    
    Parameters:
    
    optional - true if the column's values are optional, or false otherwise
    
    Returns:
    
    this editor so callers can chain methods together
  - autoIncremented
```
ColumnEditor autoIncremented(boolean autoIncremented)
```
    Set whether the column's values are automatically incremented.
    
    Parameters:
    
    autoIncremented - true if the column's values are automatically incremented by the database, or false otherwise
    
    Returns:
    
    this editor so callers can chain methods together
  - generated
```
ColumnEditor generated(boolean generated)
```
    Set whether the column's values are generated by the database.
    
    Parameters:
    
    generated - true if the column's values are generated by the database, or false otherwise
    
    Returns:
    
    this editor so callers can chain methods together
  - position
```
ColumnEditor position(int position)
```
    Set the position of the column within the table definition.
    
    Parameters:
    
    position - the new column position
    
    Returns:
    
    this editor so callers can chain methods together
  - create
```
Column create()
```
    Obtain an immutable column definition representing the current state of this editor. Typically, an editor is created and used to build a column, and then discarded. However, this editor with its current state can be reused after this method, since the resulting column definition no longer refers to any of the data used in this editor.
    
    Returns:
    
    the immutable column definition; never null

Interface ColumnEditor

Method Summary

Methods inherited from interface java.lang.Comparable

Method Detail

name

position

jdbcType

componentType

typeName

typeExpression

charsetName

charsetNameOfTable

length

scale

isOptional

isAutoIncremented

isGenerated

name

type

type

jdbcType

componentType

charsetName

charsetNameOfTable

length

scale

optional

autoIncremented

generated

position

create