Package gov.usgs.earthquake.indexer

Enum SearchMethod

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SearchMethod>
    public enum SearchMethod
extends java.lang.Enum<SearchMethod>
    Different types of searches that are supported.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static SearchMethod fromXmlMethodName​(java.lang.String xmlMethodName)
      Get the enumerated value for the given xml string.
      java.lang.String getXmlMethodName()  
      static SearchMethod valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SearchMethod[] 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

      • EVENTS_SUMMARY

        public static final SearchMethod EVENTS_SUMMARY
        Summary for multiple events.

      • EVENT_DETAIL

        public static final SearchMethod EVENT_DETAIL
        Detail for one event.

      • PRODUCTS_SUMMARY

        public static final SearchMethod PRODUCTS_SUMMARY
        Summary for multiple products.

      • PRODUCT_DETAIL

        public static final SearchMethod PRODUCT_DETAIL
        Detail for one product.

    • Method Detail

      • values

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

      • valueOf

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

      • getXmlMethodName

        public java.lang.String getXmlMethodName()
        Returns:
        The XML string used to represent this response type.

      • fromXmlMethodName

        public static SearchMethod fromXmlMethodName​(java.lang.String xmlMethodName)
        Get the enumerated value for the given xml string.
        Parameters:
        xmlMethodName - the xml name.
        Returns:
        null if xmlMethodName is unknown.