org.eclipse.scout.rt.dataobject/src/main/java/org/eclipse/scout/rt/dataobject/IDataObjectMapper.java

/*
 * Copyright (c) 2010-2018 BSI Business Systems Integration AG.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     BSI Business Systems Integration AG - initial API and implementation
 */
package org.eclipse.scout.rt.dataobject;

import java.io.InputStream;
import java.io.OutputStream;

import org.eclipse.scout.rt.platform.Bean;

/**
 * Interface to a data mapper implementation handling the mapping between data objects and their serialized String
 * representation.
 *
 * @see IDataObject
 * @see IDoEntity
 * @see DoEntity
 */
@Bean
public interface IDataObjectMapper {

  interface IMapperFeature {
    String getKey();

    String getValue();
  }

  interface IMapperFeatures {

    IMapperFeature NO_TYPE_NAME = new IMapperFeature() {
      @Override
      public String getKey() {
        return "scout.data.objectmapper.feature.noTypeName";
      }

      @Override
      public String getValue() {
        return Boolean.TRUE.toString();
      }
    };

    static IMapperFeature TYPE_ATTRIBUTE_NAME(String typeAttributeName) {
      return new IMapperFeature() {
        @Override
        public String getKey() {
          return "scout.data.objectmapper.feature.typeAttributeName";
        }

        @Override
        public String getValue() {
          return typeAttributeName;
        }
      };
    }
  }

  /**
   * Deserialize from input stream into a data object.
   */
  <T> T readValue(InputStream inputStream, Class<T> valueType);

  /**
   * Deserialize a string value into a data object.
   */
  <T> T readValue(String value, Class<T> valueType);

  /**
   * Deserialize from input stream into a generic {@link IDataObject} object tree ignoring any available type
   * attributes.
   */
  IDataObject readValueRaw(InputStream inputStream);

  /**
   * Deserialize a string value into a generic {@link IDataObject} object tree ignoring any available type attributes.
   */
  IDataObject readValueRaw(String value);

  /**
   * Serializes a data object into the given output stream.
   */
  void writeValue(OutputStream outputStream, Object value, IMapperFeature... features);

  /**
   * Serializes a data object into its string representation.
   */
  String writeValue(Object value, IMapperFeature... features);
}