Module com.speedment.runtime.join

Package com.speedment.runtime.join.stage

Enum JoinType

java.lang.Object

java.lang.Enum<JoinType>

com.speedment.runtime.join.stage.JoinType

All Implemented Interfaces:

Serializable, Comparable<JoinType>

public enum JoinType
extends Enum<JoinType>

Author:

Per Minborg

Enum Constant Summary

Enum Constants

Enum Constant	Description
CROSS_JOIN
INNER_JOIN
LEFT_JOIN
RIGHT_JOIN

Method Summary

Modifier and Type	Method	Description
boolean	isNeverNullable()	Returns if this JoinType always produce results that are NEVER null for entities belonging to another Stage.
boolean	isNullableOther()	Returns if this JoinType can produce results that are null for entities belonging to another Stage.
boolean	isNullableSelf()	Returns if this JoinType can produce results that are null for entities belonging to the same Stage where this JoinType is present.
String	sql()	Returns the SQL representation of the JoinType.
static JoinType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static JoinType[]	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 Detail

INNER_JOIN

public static final JoinType INNER_JOIN

LEFT_JOIN

public static final JoinType LEFT_JOIN

RIGHT_JOIN

public static final JoinType RIGHT_JOIN

CROSS_JOIN

public static final JoinType CROSS_JOIN

Method Detail

values

public static JoinType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JoinType c : JoinType.values())
    System.out.println(c);

Returns:

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

valueOf

public static JoinType 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

sql

public String sql()

Returns the SQL representation of the JoinType.

Returns:

the SQL representation of the JoinType

isNullableSelf

public boolean isNullableSelf()

Returns if this JoinType can produce results that are null for entities belonging to the same Stage where this JoinType is present.

Returns:

if this JoinType can produce results that are null for entities belonging to the same Stage where this JoinType is present

isNullableOther

public boolean isNullableOther()

Returns if this JoinType can produce results that are null for entities belonging to another Stage.

Returns:

if this JoinType can produce results that are null for entities belonging to another Stage

isNeverNullable

public boolean isNeverNullable()

Returns if this JoinType always produce results that are NEVER null for entities belonging to another Stage.

Returns:

if this JoinType always produce results that are NEVER null for entities belonging to another Stage.