ColumnEditorImpl (Debezium Core 0.2.1 API)

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

All Implemented Interfaces:: ColumnEditor, Comparable<Column>

final class ColumnEditorImpl
extends Object
implements ColumnEditor

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`autoIncremented`
`private boolean`	`generated`
`private int`	`jdbcType`
`private int`	`length`
`private String`	`name`
`private boolean`	`optional`
`private int`	`position`
`private int`	`scale`
`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.
`int`	`compareTo(Column that)`
`Column`	`create()` Obtain an immutable column definition representing the current state of this editor.
`ColumnEditorImpl`	`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
`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.
`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.
`int`	`scale()` Get the scale of the column.
`ColumnEditorImpl`	`scale(int scale)` Set the scale of the column.
`String`	`toString()`
`String`	`typeName()` Get the database-specific name of the column's data type.
`ColumnEditorImpl`	`typeName(String typeName)` Set the database-specific name of the column's data type.

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
```
  - typeName
```
private String typeName
```
  - length
```
private int length
```
  - scale
```
private int scale
```
  - position
```
private int position
```
  - optional
```
private boolean optional
```
  - autoIncremented
```
private boolean autoIncremented
```
  - generated
```
private boolean generated
```
- 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
  - 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
  - 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 int scale()
```
    Description copied from interface: ColumnEditor
    
    Get the scale of the column.
    
    Specified by:
    
    scale in interface ColumnEditor
    
    Returns:
    
    the scale, or -1 if the scale does not apply to this type
  - 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
  - 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
  - typeName
```
public ColumnEditorImpl typeName(String typeName)
```
    Description copied from interface: ColumnEditor
    
    Set the database-specific name of the column's data type.
    
    Specified by:
    
    typeName in interface ColumnEditor
    
    Parameters:
    
    typeName - the column's type name
    
    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
  - 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(int scale)
```
    Description copied from interface: ColumnEditor
    
    Set the scale of the column.
    
    Specified by:
    
    scale in interface ColumnEditor
    
    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
```
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
  - 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
  - compareTo
```
public int compareTo(Column that)
```
    Specified by:
    
    compareTo in interface Comparable<Column>
  - 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

typeName

length

scale

position

optional

autoIncremented

generated

Constructor Detail

ColumnEditorImpl

Method Detail

name

typeName

jdbcType

length

scale

position

isOptional

isAutoIncremented

isGenerated

name

typeName

jdbcType

length

scale

optional

autoIncremented

generated

position

create

compareTo

toString