Package org.intermine.webservice.server

Enum Format

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Format>
    public enum Format
extends java.lang.Enum<Format>

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CSV
      Comma-separated-values
      DEFAULT
      The format for when the user will accept whatever.
      EMPTY
      The format for when no value is given
      HTML
      The HTML format
      JSON
      Vanilla-JSON
      OBJECTS
      JSON Object format constant
      ROWS
      JSON Row format constant
      TABLE
      JSON Table format constant
      TEXT
      Plain Text
      TSV
      Tab-separated-values
      UNKNOWN
      The Unknown format
      XML
      XML

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.util.Set<Format> BASIC_FORMATS
      The basic formats: HTML, TEXT, XML, JSON
      static java.util.Set<Format> FLAT_FILES
      Flat file formats: TSV, CSV
      static java.util.Set<Format> JSON_FORMATS
      The JSON formats: JSON, OBJECTS, TABLE, ROWS

    • Method Summary

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • EMPTY

        public static final Format EMPTY
        The format for when no value is given

      • DEFAULT

        public static final Format DEFAULT
        The format for when the user will accept whatever.

      • UNKNOWN

        public static final Format UNKNOWN
        The Unknown format

      • HTML

        public static final Format HTML
        The HTML format

      • TEXT

        public static final Format TEXT
        Plain Text

      • XML

        public static final Format XML
        XML

      • CSV

        public static final Format CSV
        Comma-separated-values

      • TSV

        public static final Format TSV
        Tab-separated-values

      • JSON

        public static final Format JSON
        Vanilla-JSON

      • OBJECTS

        public static final Format OBJECTS
        JSON Object format constant

      • TABLE

        public static final Format TABLE
        JSON Table format constant

      • ROWS

        public static final Format ROWS
        JSON Row format constant

    • Field Detail

      • BASIC_FORMATS

        public static final java.util.Set<Format> BASIC_FORMATS
        The basic formats: HTML, TEXT, XML, JSON

      • JSON_FORMATS

        public static final java.util.Set<Format> JSON_FORMATS
        The JSON formats: JSON, OBJECTS, TABLE, ROWS

      • FLAT_FILES

        public static final java.util.Set<Format> FLAT_FILES
        Flat file formats: TSV, CSV

    • Method Detail

      • values

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

      • valueOf

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

      • getContentType

        public java.lang.String getContentType()
        Returns:
        the content type

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<Format>