Module io.ebean.core

Package io.ebeaninternal.server.query

Enum SqlJoinType

java.lang.Object

java.lang.Enum<SqlJoinType>

io.ebeaninternal.server.query.SqlJoinType

All Implemented Interfaces:

Serializable, Comparable<SqlJoinType>

public enum SqlJoinType
extends Enum<SqlJoinType>

Inner join, Outer join or automatic determination based on cardinality and optionality.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	It is automatically determined based on cardinality and optionality.
INNER	It is an inner join.
OUTER	It is an outer join.

Method Summary

Modifier and Type	Method	Description
SqlJoinType	autoToOuter()	If this is an AUTO join set it to OUTER as we are joining to a Many.
SqlJoinType	autoToOuter(SqlJoinType deploymentJoinType)	If join is AUTO but deploymentJoinType is OUTER then go into OUTER join mode.
String	literal(SqlJoinType deploymentJoinType)	Return the actual SQL join literal taking into account the current join type and the 'default join type as per deployment cardinality and optionality'.
static SqlJoinType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SqlJoinType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, 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 SqlJoinType INNER

It is an inner join.

OUTER

public static final SqlJoinType OUTER

It is an outer join.

AUTO

public static final SqlJoinType AUTO

It is automatically determined based on cardinality and optionality.

Method Details

values

public static SqlJoinType[] values()

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

Returns:

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

valueOf

public static SqlJoinType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

literal

public String literal(SqlJoinType deploymentJoinType)

Return the actual SQL join literal taking into account the current join type and the 'default join type as per deployment cardinality and optionality'.

autoToOuter

public SqlJoinType autoToOuter()

If this is an AUTO join set it to OUTER as we are joining to a Many.

autoToOuter

public SqlJoinType autoToOuter(SqlJoinType deploymentJoinType)

If join is AUTO but deploymentJoinType is OUTER then go into OUTER join mode.