com.artemis.managers.WorldSerializationManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of artemis-odb-serializer Show documentation
Fork of Artemis Entity System Framework.
There is a newer version: 2.3.0
Show newest version
package com.artemis.managers;

import com.artemis.BaseSystem;
import com.artemis.World;
import com.artemis.io.InputStreamHelper;
import com.artemis.io.SaveFileFormat;
import com.artemis.io.SerializationException;
import com.artemis.utils.IntBag;

import java.io.*;

public class WorldSerializationManager extends BaseSystem {
	private static final String TAG = WorldSerializationManager.class.getSimpleName();
	private ArtemisSerializer backend;
	public boolean alwaysLoadStreamMemory = true;


	@Override
	protected void processSystem() {
	}

	/**
	 * Provide a serializer that can read or write data in your choice of format (likely
	 * some form of data file, e.g. JSON).
	 */
	public void setSerializer(ArtemisSerializer backend) {
		this.backend = backend;
	}

	public  T getSerializer() {
		return (T) backend;
	}

	/**
	 * Loads data from an InputStream (usually a file) and provides a SaveFileFormat (or subclass)
	 * object that contains the deserialized data.
	 */
	public  T load(InputStream is, Class format) {
		if (alwaysLoadStreamMemory || !InputStreamHelper.isMarkSupported(is)) {
			try {
				byte[] buf = new byte[32768];
				ByteArrayOutputStream baos = new ByteArrayOutputStream();
				int read;
				while ((read = is.read(buf)) != -1) {
					baos.write(buf, 0, read);
				}
				is = new ByteArrayInputStream(baos.toByteArray());
				baos.close();
			} catch (IOException e) {
				throw new RuntimeException("Error copying inputstream", e);
			}
		}
		return backend.load(is, format);
	}

	@Deprecated
	public void save(Writer writer, SaveFileFormat format) {
		if (backend == null) {
			throw new RuntimeException("Missing ArtemisSerializer, see #setBackend.");
		}

		world.inject(format);
		backend.save(writer, format);
	}

	public void save(OutputStream out, SaveFileFormat format) throws SerializationException {
		if (backend == null) {
			throw new RuntimeException("Missing ArtemisSerializer, see #setBackend.");
		}

		world.inject(format);
		backend.save(out, format);
	}

	/**
	 * Override this class to actually decide the format in which an object (not necessarily
	 * of Artemis type) should be serialized.  A JSON serializer is provided, but by overriding
	 * this class you may serialize to/from YAML, XML, UDP packets, or even your own JSON format!
	 */
	public static abstract class ArtemisSerializer {
		protected World world;

		protected ArtemisSerializer(World world) {
			this.world = world;
		}

		/**
		 * Convenience method for immediately serializing a group of entities with the default
		 * SaveFileFormat.  For finer control or SaveFileFormat subclasses, use #save.
		 */
		@Deprecated
		protected final void save(Writer writer, IntBag entities) {
			save(writer, new SaveFileFormat(entities));
		}

		/**
		 * Convenience method for immediately serializing a group of entities with the default
		 * SaveFileFormat.  For finer control or SaveFileFormat subclasses, use #save.
		 */
		protected final void save(OutputStream out, IntBag entities) {
			save(out, new SaveFileFormat(entities));
		}

		/**
		 * Register a custom serializer for some known class.  It is left to the implementation
		 * to decide how this custom serializer is actually used.
		 */
		public abstract ArtemisSerializer register(Class type, T serializer);

		@Deprecated
		protected abstract void save(Writer writer, SaveFileFormat format);

		protected abstract void save(OutputStream out, SaveFileFormat format)
			throws SerializationException;
		
		/**
		 * Deserializes data (usually a file) of a known class to a SaveFileFormat.
		 */
		protected abstract  T load(InputStream is, Class format);
	}
}