Enum TdbXmlRecord.IOMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TdbXmlRecord.IOMode>
    Enclosing class:
    TdbXmlRecord

    public static enum TdbXmlRecord.IOMode
    extends java.lang.Enum<TdbXmlRecord.IOMode>
    The IOMode enum represents various ways that TRIPxml import and export operations can take place.
    See Also:
    TdbXmlRecord
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      File
      Transmission of document data will be to and from a file.
      Inline
      Transmission of document data will be inline (base64-encoded) in XPI requests and responses.
      Stream
      Transmission of document data will be streamed via a temporary HTTP connection between TRIPjxp and the server-side TRIPxml library.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static TdbXmlRecord.IOMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TdbXmlRecord.IOMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • Inline

        public static final TdbXmlRecord.IOMode Inline
        Transmission of document data will be inline (base64-encoded) in XPI requests and responses. This is the default.
      • File

        public static final TdbXmlRecord.IOMode File
        Transmission of document data will be to and from a file. This mode is only valid if the TRIPjxp application runs on the same machine as the TRIP server the session is connected to.
      • Stream

        public static final TdbXmlRecord.IOMode Stream
        Transmission of document data will be streamed via a temporary HTTP connection between TRIPjxp and the server-side TRIPxml library. This mode is only valid for records with XML content.
    • Method Detail

      • values

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

        public static TdbXmlRecord.IOMode 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