Module storm.foundation

Package st.orm

Enum Class DefaultJoinType

java.lang.Object

java.lang.Enum<DefaultJoinType>

st.orm.DefaultJoinType

All Implemented Interfaces:

Serializable, Comparable<DefaultJoinType>, Constable, JoinType

public enum DefaultJoinType
extends Enum<DefaultJoinType>
implements JoinType

Default implementation of the JoinType interface used to represent the default join types.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CROSS
INNER
LEFT
RIGHT

Method Summary

Modifier and Type	Method	Description
boolean	hasOnClause()	Whether the join type will be accompanied by an ON clause.
boolean	isOuter()	Whether the join type is an outer join.
String	sql()	The SQL representation of the join type.
static DefaultJoinType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultJoinType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INNER

public static final DefaultJoinType INNER

CROSS

public static final DefaultJoinType CROSS

LEFT

public static final DefaultJoinType LEFT

RIGHT

public static final DefaultJoinType RIGHT

Method Details

values

public static DefaultJoinType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DefaultJoinType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

sql

public String sql()

The SQL representation of the join type. For example, "INNER JOIN" or "LEFT JOIN".

Specified by:

sql in interface JoinType

Returns:

the SQL representation of the join type.

hasOnClause

public boolean hasOnClause()

Whether the join type will be accompanied by an ON clause.

Note: The JoinType implementation is not responsible for generating the ON clause. This method is used to determine whether the ON clause should be included in the generated SQL.

Specified by:

hasOnClause in interface JoinType

Returns:

true if the join type will be accompanied by an ON clause, false otherwise.

isOuter

public boolean isOuter()

Whether the join type is an outer join.

Outer joins will be treated differently when generating the SQL. Outer joins will be placed at the end of the join list to prevent undesired side effects.

Specified by:

isOuter in interface JoinType

Returns:

true if the join type is an outer join, false otherwise.