Package org.camunda.bpm.engine.variable

Enum Variables.SerializationDataFormats

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Variables.SerializationDataFormats>, SerializationDataFormat
    Enclosing class:
    Variables
    public static enum Variables.SerializationDataFormats
extends java.lang.Enum<Variables.SerializationDataFormats>
implements SerializationDataFormat

    A set of builtin serialization dataformat constants. These constants can be used to specify how java object variables should be serialized by the process engine:

     CustomerData customerData = new CustomerData();
 // ...
 ObjectValue customerDataValue = Variables.objectValue(customerData)
   .serializationDataFormat(Variables.SerializationDataFormats.JSON)
   .create();

 execution.setVariable("someVariable", customerDataValue);

    Note that not all of the formats provided here are supported out of the box.

    Author:
    Daniel Meyer

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      JAVA
      The Java Serialization Data format.
      JSON
      The Json Serialization Data format.
      XML
      The Xml Serialization Data format.

    • Method Summary

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

      • JAVA

        public static final Variables.SerializationDataFormats JAVA

        The Java Serialization Data format. If this data format is used for serializing an object, the object is serialized using default Java Serializable.

        The process engine provides a serializer for this dataformat out of the box.

      • JSON

        public static final Variables.SerializationDataFormats JSON

        The Json Serialization Data format. If this data format is used for serializing an object, the object is serialized as Json text.

        NOTE: the process does NOT provide a serializer for this dataformat out of the box. If you want to serialize objects using the Json dataformat, you need to provide a serializer. The optinal camunda Spin process engine plugin provides such a serializer.

      • XML

        public static final Variables.SerializationDataFormats XML

        The Xml Serialization Data format. If this data format is used for serializing an object, the object is serialized as Xml text.

        NOTE: the process does NOT provide a serializer for this dataformat out of the box. If you want to serialize objects using the Xml dataformat, you need to provide a serializer. The optinal camunda Spin process engine plugin provides such a serializer.

    • Method Detail

      • values

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

      • valueOf

        public static Variables.SerializationDataFormats 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