Package org.h2.engine

Class Comment

java.lang.Object

org.h2.engine.DbObject

org.h2.engine.Comment

All Implemented Interfaces:

org.h2.util.HasSQL

public final class Comment
extends DbObject

Represents a database object comment.

Field Summary

Fields inherited from class org.h2.engine.DbObject

AGGREGATE, comment, COMMENT, CONSTANT, CONSTRAINT, database, DOMAIN, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, SYNONYM, TABLE_OR_VIEW, trace, TRIGGER, USER

Fields inherited from interface org.h2.util.HasSQL

ADD_PLAN_INFORMATION, DEFAULT_SQL_FLAGS, NO_CASTS, QUOTE_ONLY_WHEN_REQUIRED, REPLACE_LOBS_FOR_TRACE, TRACE_SQL_FLAGS

Constructor Summary

Constructors

Constructor	Description
Comment(Database database, int id, DbObject obj)

Method Summary

Modifier and Type	Method	Description
void	checkRename()	Check if renaming is allowed.
String	getCreateSQL()	Construct the CREATE ...
int	getType()	Get the object type.
void	removeChildrenAndResources(SessionLocal session)	Delete all dependent children objects and resources of this object.
void	setCommentText(String comment)	Set the comment text.

Methods inherited from class org.h2.engine.DbObject

equals, getChildren, getComment, getCreateSQLForCopy, getCreateSQLForMeta, getDatabase, getDropSQL, getId, getModificationId, getName, getSQL, getSQL, hashCode, invalidate, isTemporary, isValid, rename, setComment, setModified, setObjectName, setTemporary, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.h2.util.HasSQL

getTraceSQL

Constructor Details

Comment

public Comment(Database database,
 int id,
 DbObject obj)

Method Details

getCreateSQL

public String getCreateSQL()

Description copied from class: DbObject

Construct the CREATE ... SQL statement for this object.

Specified by:

getCreateSQL in class DbObject

Returns:

the SQL statement

getType

public int getType()

Description copied from class: DbObject

Get the object type.

Specified by:

getType in class DbObject

Returns:

the object type

removeChildrenAndResources

public void removeChildrenAndResources(SessionLocal session)

Description copied from class: DbObject

Delete all dependent children objects and resources of this object.

Specified by:

removeChildrenAndResources in class DbObject

Parameters:

session - the session

checkRename

public void checkRename()

Description copied from class: DbObject

Check if renaming is allowed. Does nothing when allowed.

Overrides:

checkRename in class DbObject

setCommentText

public void setCommentText(String comment)

Set the comment text.

Parameters:

comment - the text