Package com.prowidesoftware.swift.model.mx

Enum EnvelopeType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<EnvelopeType>
    public enum EnvelopeType
extends java.lang.Enum<EnvelopeType>
    Enumeration of the envelope types use when serializing an MX message into an XML.

    The envelope is the root structure used to bind an AppHdr and Document into a single XML. This is used in the MxWriteConfiguration to customize the XML serialization.

    Since:
    9.5.0

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BME_V1
      The envelope is an ISO 20022 "BizMsgEnvlp"
      BME_V2
      The envelope is an ISO 20022 "BizMsgEnvlp"
      CUSTOM
      The envelope is a custom structure, with default root element "RequestPayload"
      SWIFT
      The envelope is a SWIFT "Envelope"

    • Method Summary

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

      • SWIFT

        public static final EnvelopeType SWIFT
        The envelope is a SWIFT "Envelope"

      • BME_V1

        public static final EnvelopeType BME_V1
        The envelope is an ISO 20022 "BizMsgEnvlp"

      • BME_V2

        public static final EnvelopeType BME_V2
        The envelope is an ISO 20022 "BizMsgEnvlp"

      • CUSTOM

        public static final EnvelopeType CUSTOM
        The envelope is a custom structure, with default root element "RequestPayload"

    • Method Detail

      • values

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

      • valueOf

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

      • rootElement

        public java.lang.String rootElement()

      • namespace

        public java.lang.String namespace()

      • prefix

        public java.lang.String prefix()