Package org.tentackle.wurblet

Enum WurbletArgumentType

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CONDITION
      An Attribute that must meet a condition.
      EXTRA
      An extra Attribute.
      Usually used for SQL UPDATE.
      JOIN
      A Relation that will be joined and eagerly loaded.
      SORT
      An Attribute used for sorting.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isAttributeAllowed()
      Returns whether an Attribute is allowed.
      boolean isAttributeOptional()
      Returns whether an Attribute may be given optionally.
      boolean isAttributeRequired()
      Returns whether an Attribute is required.
      boolean isNameOptional()
      Returns whether the name of the method argument is optional.
      boolean isPathAllowed()
      Returns whether a Relation path is allowed.
      boolean isPathOptional()
      Returns whether a Relation path may be given optionally.
      boolean isPathRequired()
      Returns whether a Relation path is required.
      boolean isRelopOptional()
      Returns whether the relop is optional.
      static WurbletArgumentType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static WurbletArgumentType[] 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

      • CONDITION

        public static final WurbletArgumentType CONDITION
        An Attribute that must meet a condition.

      • EXTRA

        public static final WurbletArgumentType EXTRA
        An extra Attribute.
        Usually used for SQL UPDATE.

      • JOIN

        public static final WurbletArgumentType JOIN
        A Relation that will be joined and eagerly loaded.

    • Method Detail

      • values

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

      • valueOf

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

      • isPathOptional

        public boolean isPathOptional()
        Returns whether a Relation path may be given optionally.
        Returns:
        true if optional, false if none or required

      • isPathRequired

        public boolean isPathRequired()
        Returns whether a Relation path is required.
        Returns:
        true if must be given, false if not allowed or optional

      • isPathAllowed

        public boolean isPathAllowed()
        Returns whether a Relation path is allowed.
        Returns:
        true if optional or required

      • isAttributeOptional

        public boolean isAttributeOptional()
        Returns whether an Attribute may be given optionally.
        Returns:
        true if optional, false if not allowed or required

      • isAttributeRequired

        public boolean isAttributeRequired()
        Returns whether an Attribute is required.
        Returns:
        true if must be given, false if none or optional

      • isAttributeAllowed

        public boolean isAttributeAllowed()
        Returns whether an Attribute is allowed.
        Returns:
        true if optional or required

      • isNameOptional

        public boolean isNameOptional()
        Returns whether the name of the method argument is optional.
        Returns:
        true if optional, false if not allowed

      • isRelopOptional

        public boolean isRelopOptional()
        Returns whether the relop is optional.
        Returns:
        true if optional, false if not allowed