com.cedarsoft.serialization.Serializer.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of serialization Show documentation
The newest version!
/**
 * Copyright (C) cedarsoft GmbH.

 * Licensed under the GNU General Public License version 3 (the "License")
 * with Classpath Exception; you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at

 * http://www.cedarsoft.org/gpl3ce
 * (GPL 3 with Classpath Exception)

 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3 only, as
 * published by the Free Software Foundation. cedarsoft GmbH designates this
 * particular file as subject to the "Classpath" exception as provided
 * by cedarsoft GmbH in the LICENSE file that accompanied this code.

 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 3 for more details (a copy is included in the LICENSE file that
 * accompanied this code).

 * You should have received a copy of the GNU General Public License version
 * 3 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 * Please contact cedarsoft GmbH, 72810 Gomaringen, Germany,
 * or visit www.cedarsoft.com if you need additional information or
 * have any questions.
 */

package com.cedarsoft.serialization

import com.cedarsoft.version.Version
import com.cedarsoft.version.VersionException
import com.cedarsoft.version.VersionRange
import java.io.IOException

/**
 * Interface for all types of serializers.


 *
 * Each serializer is able to serialize an object to a given output stream.
 *
 * A format version is supported for each serializer.
 * @param  the type of the objects this serializer is able to (de)serialize
 * @param  the type of the object that is serialized to
 * @param  the type of the object that is serialized from
 */
interface Serializer {
  /**
   * Serializes the object to the given output object
   * @param object the object to serialize
   * @param out    the out stream
   * @throws IOException if there is an io problem
   */
  @Throws(IOException::class, SerializationException::class)
  fun serialize(objectToSerialize: T, out: O)

  /**
   * Deserializes the object from the input stream
   * throws com.cedarsoft.version.VersionException if any version related problem occurred
   * @param in the input object
   * @return the deserialized object
   * @throws java.io.IOException if there is an io problem2
   */
  @Throws(IOException::class, VersionException::class, SerializationException::class)
  fun deserialize(deserializeFrom: I): T

  /**
   * Returns the format version that is written.
   * @return the format version that is written
   */
  val formatVersion: Version

  /**
   * Returns the format version range this serializer supports when reading.
   * @return the format version range that is supported
   */
  val formatVersionRange: VersionRange
}