Top Description Inners Fields Constructors Methods
org.h2.command.query

public final Class ForUpdate

extends Object
implements HasSQL
Class Inheritance
All Implemented Interfaces
org.h2.util.HasSQL
Imports
org.h2.message.DbException, org.h2.util.HasSQL, .StringUtils
FOR UPDATE clause.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
ForUpdate.Type

Type of FOR UPDATE clause.

Field Summary

Modifier and TypeField and Description
public static final ForUpdate
DEFAULT

FOR UPDATE clause without additional parameters.

public static final ForUpdate
NOWAIT

FOR UPDATE NOWAIT clause.

public static final ForUpdate
SKIP_LOCKED

FOR UPDATE SKIP LOCKED clause.

private final int
timeoutMillis

private final ForUpdate.Type
type

Constructor Summary

AccessConstructor and Description
private
ForUpdate(ForUpdate.Type type, int timeoutMillis)

Method Summary

Modifier and TypeMethod and Description
public StringBuilder
getSQL(StringBuilder
string builder
builder, int
formatting flags
sqlFlags)

Implements org.h2.util.HasSQL.getSQL.

Appends the SQL statement of this object to the specified builder.

public int

Returns:

timeout in milliseconds for Type#WAIT, 0 for Type#NOWAIT, -2 for Type#SKIP_LOCKED, -1 for default timeout
getTimeoutMillis()

Returns timeout in milliseconds.

public ForUpdate.Type

Returns:

type of FOR UPDATE clause
getType()

Returns type of FOR UPDATE clause.

public static final ForUpdate

Returns:

FOR UPDATE WAIT N clause
wait(int
timeout in milliseconds
timeoutMillis)

Returns FOR UPDATE WAIT N clause.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULTback to summary
public static final ForUpdate DEFAULT

FOR UPDATE clause without additional parameters.

NOWAITback to summary
public static final ForUpdate NOWAIT

FOR UPDATE NOWAIT clause.

SKIP_LOCKEDback to summary
public static final ForUpdate SKIP_LOCKED

FOR UPDATE SKIP LOCKED clause.

timeoutMillisback to summary
private final int timeoutMillis
typeback to summary
private final ForUpdate.Type type

Constructor Detail

ForUpdateback to summary
private ForUpdate(ForUpdate.Type type, int timeoutMillis)

Method Detail

getSQLback to summary
public StringBuilder getSQL(StringBuilder builder, int sqlFlags)

Implements org.h2.util.HasSQL.getSQL.

Doc from org.h2.util.HasSQL.getSQL.

Appends the SQL statement of this object to the specified builder.

Parameters
builder:StringBuilder

string builder

sqlFlags:int

formatting flags

Returns:StringBuilder

the specified string builder

Annotations
@Override
getTimeoutMillisback to summary
public int getTimeoutMillis()

Returns timeout in milliseconds.

Returns:int

timeout in milliseconds for Type#WAIT, 0 for Type#NOWAIT, -2 for Type#SKIP_LOCKED, -1 for default timeout

getTypeback to summary
public ForUpdate.Type getType()

Returns type of FOR UPDATE clause.

Returns:ForUpdate.Type

type of FOR UPDATE clause

waitback to summary
public static final ForUpdate wait(int timeoutMillis)

Returns FOR UPDATE WAIT N clause.

Parameters
timeoutMillis:int

timeout in milliseconds

Returns:ForUpdate

FOR UPDATE WAIT N clause

org.h2.command.query back to summary

public final Enum ForUpdate.Type

extends Enum<ForUpdate.Type>
Class Inheritance
Type of FOR UPDATE clause.

Field Summary

Modifier and TypeField and Description
public static final ForUpdate.Type
DEFAULT

Use default lock timeout.

public static final ForUpdate.Type
NOWAIT

Use zero timeout.

public static final ForUpdate.Type
SKIP_LOCKED

Skip locked rows.

public static final ForUpdate.Type
WAIT

Use specified lock timeout.

Constructor Summary

AccessConstructor and Description
private
Type()

Method Summary

Modifier and TypeMethod and Description
public static ForUpdate.Type
valueOf(String name)

public static ForUpdate.Type[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

DEFAULTback to summary
public static final ForUpdate.Type DEFAULT

Use default lock timeout.

NOWAITback to summary
public static final ForUpdate.Type NOWAIT

Use zero timeout.

SKIP_LOCKEDback to summary
public static final ForUpdate.Type SKIP_LOCKED

Skip locked rows.

WAITback to summary
public static final ForUpdate.Type WAIT

Use specified lock timeout.

Constructor Detail

Typeback to summary
private Type()

Method Detail

valueOfback to summary
public static ForUpdate.Type valueOf(String name)
valuesback to summary
public static ForUpdate.Type[] values()