Enum TagSearchOptions

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TagSearchOptions>

    public enum TagSearchOptions
    extends java.lang.Enum<TagSearchOptions>
    Enumeration that defines the tag search options.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ByAllTags
      Search objects that have all of the tags in common.
      ByAnyTag
      Search objects that have any of the specified tags in common.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static TagSearchOptions forValue​(int value)
      rete the enum constant of the specified value, if exists.
      int getValue()
      Order is important in enums.By using getValue() method, each enum constant index can be found, just like array index.
      static TagSearchOptions valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TagSearchOptions[] 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

      • ByAllTags

        public static final TagSearchOptions ByAllTags
        Search objects that have all of the tags in common.
      • ByAnyTag

        public static final TagSearchOptions ByAnyTag
        Search objects that have any of the specified tags in common.
    • Method Detail

      • values

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

        public static TagSearchOptions 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
      • forValue

        public static TagSearchOptions forValue​(int value)
        rete the enum constant of the specified value, if exists.
        Parameters:
        value - enum constant index
        Returns:
        enum constant
      • getValue

        public int getValue()
        Order is important in enums.By using getValue() method, each enum constant index can be found, just like array index.
        Returns:
        enum constant index