ColumnEditorImpl (Debezium Core 1.4.0.Final API)

java.lang.Object
- io.debezium.relational.ColumnEditorImpl

All Implemented Interfaces:: ColumnEditor

final class ColumnEditorImpl
extends Object
implements ColumnEditor

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`autoIncremented`
`private String`	`charsetName`
`private Object`	`defaultValue`
`private List<String>`	`enumValues`
`private boolean`	`generated`
`private boolean`	`hasDefaultValue`
`private int`	`jdbcType`
`private int`	`length`
`private String`	`name`
`private int`	`nativeType`
`private boolean`	`optional`
`private int`	`position`
`private Integer`	`scale`
`private String`	`tableCharsetName`
`private String`	`typeExpression`
`private String`	`typeName`

Constructor Summary

Constructors
Modifier Constructor and Description

protected ColumnEditorImpl()

Constructors
Modifier	Constructor and Description
`protected`	`ColumnEditorImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ColumnEditorImpl`	`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.
`Column`	`create()` Obtain an immutable column definition representing the current state of this editor.
`Object`	`defaultValue()` Get the default value of the column.
`ColumnEditor`	`defaultValue(Object defaultValue)` Set the default value of the column;
`List<String>`	`enumValues()` get the enumeration values for the column.
`ColumnEditor`	`enumValues(List<String> enumValues)` Set the list of enumeration values.
`ColumnEditorImpl`	`generated(boolean generated)` Set whether the column's values are generated by the database.
`boolean`	`hasDefaultValue()` Determine whether this column's has a default value set
`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
`ColumnEditorImpl`	`jdbcType(int jdbcType)` Set the `JDBC type` of this column.
`int`	`length()` Get the maximum length of this column's values.
`ColumnEditorImpl`	`length(int length)` Set the maximum length of this column's values.
`String`	`name()` Get the name of the column.
`ColumnEditorImpl`	`name(String name)` Set the name of the column.
`int`	`nativeType()` Get the internal database-specific type identifier for this column.
`ColumnEditorImpl`	`nativeType(int nativeType)` Set the native type for this column .
`ColumnEditorImpl`	`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.
`ColumnEditorImpl`	`position(int position)` Set the position of the column within the table definition.
`Optional<Integer>`	`scale()` Get the scale of the column.
`ColumnEditorImpl`	`scale(Integer scale)` Set the scale of the column.
`String`	`toString()`
`ColumnEditorImpl`	`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.
`ColumnEditor`	`unsetDefaultValue()` Unsets the default value of the column, reverting the editor to the state where `#defaultValue(Object))` has never been called

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
private String name
```
  - jdbcType
```
private int jdbcType
```
  - nativeType
```
private int nativeType
```
  - typeName
```
private String typeName
```
  - typeExpression
```
private String typeExpression
```
  - charsetName
```
private String charsetName
```
  - tableCharsetName
```
private String tableCharsetName
```
  - length
```
private int length
```
  - scale
```
private Integer scale
```
  - position
```
private int position
```
  - optional
```
private boolean optional
```
  - autoIncremented
```
private boolean autoIncremented
```
  - generated
```
private boolean generated
```
  - defaultValue
```
private Object defaultValue
```
  - hasDefaultValue
```
private boolean hasDefaultValue
```
  - enumValues
```
private List<String> enumValues
```
- Constructor Detail
  - ColumnEditorImpl
```
protected ColumnEditorImpl()
```
- Method Detail
  - name
```
public String name()
```
    Description copied from interface: ColumnEditor
    
    Get the name of the column.
    
    Specified by:
    
    name in interface ColumnEditor
    
    Returns:
    
    the column name; may be null if not set
  - typeName
```
public String typeName()
```
    Description copied from interface: ColumnEditor
    
    Get the database-specific name of the column's data type.
    
    Specified by:
    
    typeName in interface ColumnEditor
    
    Returns:
    
    the name of the type; may be null if not set
  - typeExpression
```
public String typeExpression()
```
    Description copied from interface: ColumnEditor
    
    Get the database-specific complete expression defining the column's data type, including dimensions, length, precision, character sets, constraints, etc.
    
    Specified by:
    
    typeExpression in interface ColumnEditor
    
    Returns:
    
    the complete type expression
  - jdbcType
```
public int jdbcType()
```
    Description copied from interface: ColumnEditor
    
    Get the JDBC type for this column
    
    Specified by:
    
    jdbcType in interface ColumnEditor
    
    Returns:
    
    the type constant
  - nativeType
```
public int nativeType()
```
    Description copied from interface: ColumnEditor
    
    Get the internal database-specific type identifier for this column.
    
    Specified by:
    
    nativeType in interface ColumnEditor
    
    Returns:
    
    a type constant for the specific database
  - charsetName
```
public String charsetName()
```
    Description copied from interface: ColumnEditor
    
    Get the database-specific name of the character set used by this column.
    
    Specified by:
    
    charsetName in interface ColumnEditor
    
    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
```
public String charsetNameOfTable()
```
    Description copied from interface: ColumnEditor
    
    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.
    
    Specified by:
    
    charsetNameOfTable in interface ColumnEditor
    
    Returns:
    
    the database-specific character set name defined for this column's table, or null if not defined
  - length
```
public int length()
```
    Description copied from interface: ColumnEditor
    
    Get the maximum length of this column's values. For numeric columns, this represents the precision.
    
    Specified by:
    
    length in interface ColumnEditor
    
    Returns:
    
    the length of the column
  - scale
```
public Optional<Integer> scale()
```
    Description copied from interface: ColumnEditor
    
    Get the scale of the column.
    
    Specified by:
    
    scale in interface ColumnEditor
    
    Returns:
    
    the scale if present
  - position
```
public int position()
```
    Description copied from interface: ColumnEditor
    
    Get the position of the column in the table.
    
    Specified by:
    
    position in interface ColumnEditor
    
    Returns:
    
    the 1-based position
  - isOptional
```
public boolean isOptional()
```
    Description copied from interface: ColumnEditor
    
    Determine whether this column is optional.
    
    Specified by:
    
    isOptional in interface ColumnEditor
    
    Returns:
    
    true if it is optional, or false otherwise
  - isAutoIncremented
```
public boolean isAutoIncremented()
```
    Description copied from interface: ColumnEditor
    
    Determine whether this column's values are automatically incremented by the database.
    
    Specified by:
    
    isAutoIncremented in interface ColumnEditor
    
    Returns:
    
    true if the values are auto-incremented, or false otherwise
  - isGenerated
```
public boolean isGenerated()
```
    Description copied from interface: ColumnEditor
    
    Determine whether this column's values are generated by the database.
    
    Specified by:
    
    isGenerated in interface ColumnEditor
    
    Returns:
    
    true if the values are generated, or false otherwise
  - defaultValue
```
public Object defaultValue()
```
    Description copied from interface: ColumnEditor
    
    Get the default value of the column.
    
    Specified by:
    
    defaultValue in interface ColumnEditor
    
    Returns:
    
    the default value
  - hasDefaultValue
```
public boolean hasDefaultValue()
```
    Description copied from interface: ColumnEditor
    
    Determine whether this column's has a default value set
    
    Specified by:
    
    hasDefaultValue in interface ColumnEditor
    
    Returns:
    
    true if the default value was provided, or false otherwise
  - name
```
public ColumnEditorImpl name(String name)
```
    Description copied from interface: ColumnEditor
    
    Set the name of the column.
    
    Specified by:
    
    name in interface ColumnEditor
    
    Parameters:
    
    name - the column name
    
    Returns:
    
    this editor so callers can chain methods together
  - enumValues
```
public List<String> enumValues()
```
    Description copied from interface: ColumnEditor
    
    get the enumeration values for the column.
    
    Specified by:
    
    enumValues in interface ColumnEditor
    
    Returns:
    
    the list of enumeration values
  - type
```
public ColumnEditorImpl type(String typeName)
```
    Description copied from interface: ColumnEditor
    
    Set the database-specific name of the column's data type.
    
    Specified by:
    
    type in interface ColumnEditor
    
    Parameters:
    
    typeName - the column's type name
    
    Returns:
    
    this editor so callers can chain methods together
  - type
```
public ColumnEditor type(String typeName,
                         String typeExpression)
```
    Description copied from interface: ColumnEditor
    
    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.
    
    Specified by:
    
    type in interface ColumnEditor
    
    Parameters:
    
    typeName - the column's type name
    
    typeExpression - the column's complete type expression
    
    Returns:
    
    this editor so callers can chain methods together
  - jdbcType
```
public ColumnEditorImpl jdbcType(int jdbcType)
```
    Description copied from interface: ColumnEditor
    
    Set the JDBC type of this column.
    
    Specified by:
    
    jdbcType in interface ColumnEditor
    
    Parameters:
    
    jdbcType - JDBC type for this column
    
    Returns:
    
    this editor so callers can chain methods together
  - nativeType
```
public ColumnEditorImpl nativeType(int nativeType)
```
    Description copied from interface: ColumnEditor
    
    Set the native type for this column . This is database specific.
    
    Specified by:
    
    nativeType in interface ColumnEditor
    
    Returns:
    
    a type constant for the specific database
  - charsetName
```
public ColumnEditor charsetName(String charsetName)
```
    Description copied from interface: ColumnEditor
    
    Set the database-specific name of the character set used by this column.
    
    Specified by:
    
    charsetName in interface ColumnEditor
    
    Parameters:
    
    charsetName - the database-specific character set name; may be null
    
    Returns:
    
    this editor so callers can chain methods together
  - charsetNameOfTable
```
public ColumnEditor charsetNameOfTable(String charsetName)
```
    Description copied from interface: ColumnEditor
    
    Set the database-specific name of the character set defined by this column's table.
    
    Specified by:
    
    charsetNameOfTable in interface ColumnEditor
    
    Parameters:
    
    charsetName - the database-specific character set name; may be null
    
    Returns:
    
    this editor so callers can chain methods together
  - length
```
public ColumnEditorImpl length(int length)
```
    Description copied from interface: ColumnEditor
    
    Set the maximum length of this column's values. For numeric columns, this represents the precision.
    
    Specified by:
    
    length in interface ColumnEditor
    
    Parameters:
    
    length - the column's length
    
    Returns:
    
    this editor so callers can chain methods together
  - scale
```
public ColumnEditorImpl scale(Integer scale)
```
    Description copied from interface: ColumnEditor
    
    Set the scale of the column.
    
    Specified by:
    
    scale in interface ColumnEditor
    
    Parameters:
    
    scale - the scale or null to unset
    
    Returns:
    
    this editor so callers can chain methods together
  - optional
```
public ColumnEditorImpl optional(boolean optional)
```
    Description copied from interface: ColumnEditor
    
    Set whether the column's values are optional (e.g., can contain nulls).
    
    Specified by:
    
    optional in interface ColumnEditor
    
    Parameters:
    
    optional - true if the column's values are optional, or false otherwise
    
    Returns:
    
    this editor so callers can chain methods together
  - autoIncremented
```
public ColumnEditorImpl autoIncremented(boolean autoIncremented)
```
    Description copied from interface: ColumnEditor
    
    Set whether the column's values are automatically incremented.
    
    Specified by:
    
    autoIncremented in interface ColumnEditor
    
    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
```
public ColumnEditorImpl generated(boolean generated)
```
    Description copied from interface: ColumnEditor
    
    Set whether the column's values are generated by the database.
    
    Specified by:
    
    generated in interface ColumnEditor
    
    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
```
public ColumnEditorImpl position(int position)
```
    Description copied from interface: ColumnEditor
    
    Set the position of the column within the table definition.
    
    Specified by:
    
    position in interface ColumnEditor
    
    Parameters:
    
    position - the new column position
    
    Returns:
    
    this editor so callers can chain methods together
  - defaultValue
```
public ColumnEditor defaultValue(Object defaultValue)
```
    Description copied from interface: ColumnEditor
    
    Set the default value of the column;
    
    Specified by:
    
    defaultValue in interface ColumnEditor
    
    Parameters:
    
    defaultValue - the default value
    
    Returns:
    
    this editor so callers can chain methods together
  - unsetDefaultValue
```
public ColumnEditor unsetDefaultValue()
```
    Description copied from interface: ColumnEditor
    
    Unsets the default value of the column, reverting the editor to the state where #defaultValue(Object)) has never been called
    
    Specified by:
    
    unsetDefaultValue in interface ColumnEditor
    
    Returns:
    
    this editor so callers can chain methods together
  - enumValues
```
public ColumnEditor enumValues(List<String> enumValues)
```
    Description copied from interface: ColumnEditor
    
    Set the list of enumeration values.
    
    Specified by:
    
    enumValues in interface ColumnEditor
    
    Parameters:
    
    enumValues - the enumeration values
    
    Returns:
    
    this editor so callers can chain methods together
  - create
```
public Column create()
```
    Description copied from interface: ColumnEditor
    
    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.
    
    Specified by:
    
    create in interface ColumnEditor
    
    Returns:
    
    the immutable column definition; never null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ColumnEditorImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

jdbcType

nativeType

typeName

typeExpression

charsetName

tableCharsetName

length

scale

position

optional

autoIncremented

generated

defaultValue

hasDefaultValue

enumValues

Constructor Detail

ColumnEditorImpl

Method Detail

name

typeName

typeExpression

jdbcType

nativeType

charsetName

charsetNameOfTable

length

scale

position

isOptional

isAutoIncremented

isGenerated

defaultValue

hasDefaultValue

name

enumValues

type

type

jdbcType

nativeType

charsetName

charsetNameOfTable

length

scale

optional

autoIncremented

generated

position

defaultValue

unsetDefaultValue

enumValues

create

toString