Package org.camunda.bpm.client.spi

Interface DataFormat

All Known Implementing Classes:
DomXmlDataFormat, JacksonJsonDataFormat, SerializableDataFormat
public interface DataFormat
Maps a java object to the data format's internal representation and vice versa.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canMap(Object value)
    Returns true if this data format can map the provided Java Object.
    String
    getCanonicalTypeName(Object value)
    Returns a data-format-specific canonical type name.
    String
    getName()
    Returns the data format name.
    <T> T
    readValue(String value, Class<T> cls)
    Reads the internal representation of a data format to a java object of the desired class.
    <T> T
    readValue(String value, String typeIdentifier)
    Reads the internal representation of a data format to a java object of the desired class.
    String
    writeValue(Object value)
    Writes a java object to a data format's internal data representation.

  • Method Details

    • getName

      String getName()
      Returns the data format name.

    • canMap

      boolean canMap(Object value)
      Returns true if this data format can map the provided Java Object.
      Parameters:
      parameter - the java object to check
      Returns:
      true if this object can be mapped.

    • writeValue

      String writeValue(Object value)
      Writes a java object to a data format's internal data representation.
      Parameters:
      value - object that is written into internal data representation
      Returns:
      the data format's internal representation of that object

    • readValue

      <T> T readValue(String value, String typeIdentifier)
      Reads the internal representation of a data format to a java object of the desired class.
      Parameters:
      value - the object to be read
      typeIdentifier - the class to map the object to
      Returns:
      a java object of the specified class that was populated with the input parameter

    • readValue

      <T> T readValue(String value, Class<T> cls)
      Reads the internal representation of a data format to a java object of the desired class.
      Parameters:
      value - the object to be read
      cls - a data-format-specific type identifier that describes the class to map to
      Returns:
      a java object of the specified class that was populated with the input parameter

    • getCanonicalTypeName

      String getCanonicalTypeName(Object value)
      Returns a data-format-specific canonical type name.