org.apache.gravitino.rel

Class TableChange.UpdateColumnComment

java.lang.Object

org.apache.gravitino.rel.TableChange.UpdateColumnComment

All Implemented Interfaces:

TableChange, TableChange.ColumnChange

Enclosing interface:

TableChange

public static final class TableChange.UpdateColumnComment
extends java.lang.Object
implements TableChange.ColumnChange

A TableChange to update the comment of a field.

The field names are used to find the field to update.

If the field does not exist, the change must result in an IllegalArgumentException.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.gravitino.rel.TableChange

TableChange.AddColumn, TableChange.AddIndex, TableChange.After, TableChange.ColumnChange, TableChange.ColumnPosition, TableChange.Default, TableChange.DeleteColumn, TableChange.DeleteIndex, TableChange.First, TableChange.RemoveProperty, TableChange.RenameColumn, TableChange.RenameTable, TableChange.SetProperty, TableChange.UpdateColumnAutoIncrement, TableChange.UpdateColumnComment, TableChange.UpdateColumnDefaultValue, TableChange.UpdateColumnNullability, TableChange.UpdateColumnPosition, TableChange.UpdateColumnType, TableChange.UpdateComment

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compares this UpdateColumnComment instance with another object for equality.
java.lang.String[]	fieldName() Retrieves the field name of the column to be modified.
java.lang.String[]	getFieldName() Retrieves the field name of the column whose comment is being updated.
java.lang.String	getNewComment() Retrieves the new comment for the column.
int	hashCode() Generates a hash code for this UpdateColumnComment instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.gravitino.rel.TableChange

addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addIndex, deleteColumn, deleteIndex, removeProperty, rename, renameColumn, setProperty, updateColumnAutoIncrement, updateColumnComment, updateColumnDefaultValue, updateColumnNullability, updateColumnPosition, updateColumnType, updateComment

Method Detail

getFieldName

public java.lang.String[] getFieldName()

Retrieves the field name of the column whose comment is being updated.

Returns:

An array of strings representing the field name.

getNewComment

public java.lang.String getNewComment()

Retrieves the new comment for the column.

Returns:

The new comment of the column.

equals

public boolean equals(java.lang.Object o)

Compares this UpdateColumnComment instance with another object for equality. The comparison is based on the field name array and the new comment.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to compare with this instance.

Returns:

true if the given object represents the same comment update; false otherwise.

hashCode

public int hashCode()

Generates a hash code for this UpdateColumnComment instance. The hash code is based on both the hierarchical field name and the new comment.

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code value for this comment update operation.

fieldName

public java.lang.String[] fieldName()

Description copied from interface: TableChange.ColumnChange

Retrieves the field name of the column to be modified.

Specified by:

fieldName in interface TableChange.ColumnChange

Returns:

An array of strings representing the field name.