Package com.github.eikecochu.sqlbuilder

Enum JoinMode

  • All Implemented Interfaces:
    QueryPart, java.io.Serializable, java.lang.Comparable<JoinMode>
    public enum JoinMode
extends java.lang.Enum<JoinMode>
implements QueryPart
    The JoinMode describes how a JOIN between two elements is made.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String string​(QueryOptions options)
      Transforms this statement into an SQL string
      static JoinMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static JoinMode[] 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

      • Methods inherited from interface com.github.eikecochu.sqlbuilder.QueryPart

        string

    • Enum Constant Detail

      • INNER_JOIN

        public static final JoinMode INNER_JOIN
        The INNER JOIN mode. Default mode. Will join only if both sides have matching values.

      • OUTER_JOIN

        public static final JoinMode OUTER_JOIN
        The OUTER JOIN mode. Also FULL OUTER JOIN mode. Will join two elements regardless of matching values.

      • LEFT_JOIN

        public static final JoinMode LEFT_JOIN
        The LEFT JOIN mode. Will join two elements if both sides have matching values or only the left side has values.

      • RIGHT_JOIN

        public static final JoinMode RIGHT_JOIN
        The RIGHT JOIN mode. Will join two elements if both sides have matching values or only the right side has values.

      • CROSS_JOIN

        public static final JoinMode CROSS_JOIN
        The CROSS JOIN mode. Will join two elements for every possible value combination.

    • Method Detail

      • values

        public static JoinMode[] 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 (JoinMode c : JoinMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static JoinMode valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • string

        public java.lang.String string​(QueryOptions options)
        Description copied from interface: QueryPart
        Transforms this statement into an SQL string
        Specified by:
        string in interface QueryPart
        Parameters:
        options - The QueryOptions to apply for transformation
        Returns:
        The created SQL string