Package adams.core

Interface SerializableObject

  • All Superinterfaces:
    Serializable
    public interface SerializableObject
extends Serializable
    Interface for classes that handle their own serialization/deserialization.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)

    • Method Detail

      • setSerializationFile

        void setSerializationFile​(PlaceholderFile value)
        Sets the file to serialize to.
        Parameters:
        value - the file

      • getSerializationFile

        PlaceholderFile getSerializationFile()
        Returns the current file to serialize to.
        Returns:
        the file

      • serializationFileTipText

        String serializationFileTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOverrideSerializedFile

        void setOverrideSerializedFile​(boolean value)
        Sets whether to override an existing serialized setup.
        Parameters:
        value - true if to override existing setup

      • getOverrideSerializedFile

        boolean getOverrideSerializedFile()
        Returns whether to override an existing serialized setup.
        Returns:
        true if existing file is ignored

      • overrideSerializedFileTipText

        String overrideSerializedFileTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • initSerializationSetup

        void initSerializationSetup()
        Regenerates all the objects that are necessary for serialization.

      • retrieveSerializationSetup

        Object[] retrieveSerializationSetup()
        Returns the member variables to serialize to a file.
        Returns:
        the objects to serialize

      • setSerializationSetup

        void setSerializationSetup​(Object[] value)
        Updates the member variables with the provided objects obtained from deserialization.
        Parameters:
        value - the deserialized objects

      • setSetupLoadedOrGenerated

        void setSetupLoadedOrGenerated​(boolean value)
        Sets whether the setup was loaded/generated.
        Parameters:
        value - true if loaded/generated

      • isSetupLoadedOrGenerated

        boolean isSetupLoadedOrGenerated()
        Returns whether the setup was loaded/generated.
        Returns:
        true if loaded/generated