Class NeqSimXtream

java.lang.Object

neqsim.util.serialization.NeqSimXtream

public class NeqSimXtream
extends Object

NeqSimXtream class for serializing and deserializing NeqSim objects.

Provides compressed XML serialization using XStream with ZIP compression. The resulting .neqsim files are compact and portable.

Features:

• Automatic ThreadLocal field exclusion
• ZIP compression for compact storage
• Full object graph preservation with ID references
• Graceful handling of unknown fields/classes for cross-version compatibility

Version:

1.0

Author:

esol

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	NeqSimXtream.ThreadLocalSkipMapper	Mapper that skips ThreadLocal fields during serialization.
private static class	NeqSimXtream.UnknownElementIgnorer	Mapper that silently ignores unknown elements during deserialization.

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.apache.logging.log4j.Logger	logger	Logger for this class.

Constructor Summary

Constructors

Constructor	Description
NeqSimXtream()

Method Summary

Modifier and Type	Method	Description
private static com.thoughtworks.xstream.XStream	createConfiguredXStream()	Creates a configured XStream instance with sensible defaults for NeqSim serialization.
static Object	openNeqsim(String filename)	Opens and deserializes an object from a compressed .neqsim file.
static boolean	saveNeqsim(Object javaobject, String filename)	Saves an object to a compressed .neqsim file.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

private static final org.apache.logging.log4j.Logger logger

Logger for this class.

Constructor Details

NeqSimXtream

public NeqSimXtream()

Method Details

openNeqsim

public static Object openNeqsim(String filename)
                         throws IOException

Opens and deserializes an object from a compressed .neqsim file.

Parameters:

filename - the path to the .neqsim file

Returns:

the deserialized object

Throws:

IOException - if the file cannot be read or is not a valid .neqsim file

FileNotFoundException - if the file does not exist or process.xml is not found in ZIP

saveNeqsim

public static boolean saveNeqsim(Object javaobject,
 String filename)

Saves an object to a compressed .neqsim file.

The object is serialized to XML using XStream and compressed using ZIP compression.

Parameters:

javaobject - the object to serialize (typically ProcessSystem or ProcessModel)

filename - the path to save to (recommended extension: .neqsim)

Returns:

true if save was successful, false otherwise

createConfiguredXStream

private static com.thoughtworks.xstream.XStream createConfiguredXStream()

Creates a configured XStream instance with sensible defaults for NeqSim serialization.

Uses the default reflection provider (sun.misc.Unsafe when available) to avoid ExceptionInInitializerError that occurs with PureJavaReflectionProvider on JDK 11+. Includes mapper wrappers to skip ThreadLocal fields and gracefully ignore unknown elements for cross-version compatibility.

Returns:

a configured XStream instance