Enum TopicSearchOptions

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

    public enum TopicSearchOptions
    extends java.lang.Enum<TopicSearchOptions>
    Specifies the option through which the topic is searched by.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ByName
      Search by name.
      ByPattern
      Search by pattern.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static TopicSearchOptions forValue​(int value)
      retreives 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 TopicSearchOptions valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TopicSearchOptions[] 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
    • Method Detail

      • values

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

        public static TopicSearchOptions 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 TopicSearchOptions forValue​(int value)
        retreives 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