Top Description Fields Constructors Methods
org.eclipse.persistence.internal.expressions

public Class ForUpdateClause

extends Object
implements Serializable, Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable, java.io.Serializable
Known Direct Subclasses
org.eclipse.persistence.internal.expressions.ForUpdateOfClause
Imports
java.io.*, java.util.HashSet, .Collection, org.eclipse.persistence.queries.ObjectBuildingQuery

Purpose:Represents The FOR UPDATE pessimistically locking clause.
Author
Stephen McRitchie
Since
Oracle Toplink 10g AS

Field Summary

Modifier and TypeField and Description
pack-priv short
protected static final ForUpdateClause
pack-priv Integer

Constructor Summary

AccessConstructor and Description
public
public
ForUpdateClause(short lockMode)

public
ForUpdateClause(Integer waitTimeout)

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides java.lang.Object.clone.

Creates and returns a copy of this object.
public Collection<E>
getAliasesOfTablesToBeLocked(SQLSelectStatement statement)

INTERNAL: Returns collection of aliases of the tables to be locked.

public short
public Integer
public boolean
public boolean
public static ForUpdateClause
newInstance(short lockMode)

public static ForUpdateClause
newInstance(Integer waitTimeout)

public void
printSQL(ExpressionSQLPrinter printer, SQLSelectStatement statement)

INTERNAL: Prints the as of clause for an expression inside of the FROM clause.

Inherited from java.lang.Object:
equalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

lockModeback to summary
pack-priv short lockMode
NO_LOCK_CLAUSEback to summary
protected static final ForUpdateClause NO_LOCK_CLAUSE
waitTimeoutback to summary
pack-priv Integer waitTimeout

Constructor Detail

ForUpdateClauseback to summary
public ForUpdateClause()
ForUpdateClauseback to summary
public ForUpdateClause(short lockMode)
ForUpdateClauseback to summary
public ForUpdateClause(Integer waitTimeout)

Method Detail

cloneback to summary
public Object clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x
will be true, and that the expression:
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations
@Override
getAliasesOfTablesToBeLockedback to summary
public Collection<E> getAliasesOfTablesToBeLocked(SQLSelectStatement statement)

INTERNAL: Returns collection of aliases of the tables to be locked. Only used by platforms that lock tables individually in FROM clause (platform.shouldPrintLockingClauseAfterWhereClause()==false) like SQLServer

getLockModeback to summary
public short getLockMode()
getWaitTimeoutback to summary
public Integer getWaitTimeout()
isForUpdateOfClauseback to summary
public boolean isForUpdateOfClause()
isReferenceClassLockedback to summary
public boolean isReferenceClassLocked()
newInstanceback to summary
public static ForUpdateClause newInstance(short lockMode)
newInstanceback to summary
public static ForUpdateClause newInstance(Integer waitTimeout)
printSQLback to summary
public void printSQL(ExpressionSQLPrinter printer, SQLSelectStatement statement)

INTERNAL: Prints the as of clause for an expression inside of the FROM clause.