Enum LoadPlan.Disposition

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<LoadPlan.Disposition>
    Enclosing interface:
    LoadPlan

    public static enum LoadPlan.Disposition
    extends java.lang.Enum<LoadPlan.Disposition>
    Enumerated possibilities for describing the disposition of this LoadPlan.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      COLLECTION_INITIALIZER
      This is a "collection initializer" load plan, which describes a plan for loading one or more entity instances of the same collection type.
      ENTITY_LOADER
      This is an "entity loader" load plan, which describes a plan for loading one or more entity instances of the same entity type.
      MIXED
      We have a mixed load plan, which will have one or more returns of EntityReturn and ScalarReturn (NOT CollectionReturn).
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static LoadPlan.Disposition valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static LoadPlan.Disposition[] 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

      • ENTITY_LOADER

        public static final LoadPlan.Disposition ENTITY_LOADER
        This is an "entity loader" load plan, which describes a plan for loading one or more entity instances of the same entity type. There is a single return, which will be of type EntityReturn
      • COLLECTION_INITIALIZER

        public static final LoadPlan.Disposition COLLECTION_INITIALIZER
        This is a "collection initializer" load plan, which describes a plan for loading one or more entity instances of the same collection type. There is a single return, which will be of type CollectionReturn
    • Method Detail

      • values

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

        public static LoadPlan.Disposition 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