Package org.hibernate.type

Enum ForeignKeyDirection

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ForeignKeyDirection>
    public enum ForeignKeyDirection
extends java.lang.Enum<ForeignKeyDirection>
    Represents directionality of the foreign key constraint

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FROM_PARENT
      A foreign key from parent to child
      TO_PARENT
      A foreign key from child to parent

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract boolean cascadeNow​(org.hibernate.engine.internal.CascadePoint cascadePoint)
      Should we cascade at this cascade point?
      static ForeignKeyDirection valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ForeignKeyDirection[] 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

      • TO_PARENT

        public static final ForeignKeyDirection TO_PARENT
        A foreign key from child to parent

      • FROM_PARENT

        public static final ForeignKeyDirection FROM_PARENT
        A foreign key from parent to child

    • Method Detail

      • values

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

      • valueOf

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

      • cascadeNow

        public abstract boolean cascadeNow​(org.hibernate.engine.internal.CascadePoint cascadePoint)
        Should we cascade at this cascade point?
        Parameters:
        cascadePoint - The point at which the cascade is being initiated.
        Returns:
        true if cascading should be performed now.
        See Also:
        Cascade