com.webobjects.eocontrol
Interface EOKeyValueArchiving

All Known Implementing Classes:

EOAndQualifier, EOEditingContext, EOFetchSpecification, EONotQualifier, EOKeyValueQualifier, EODetailDataSource, EOQualifierVariable, EOSortOrdering, EOOrQualifier, EOKeyComparisonQualifier, EODatabaseDataSource, WODisplayGroup, ServerSideAction, NonNullQualifier, Assignment, BooleanQualifier, D2WModel, Rule

public interface EOKeyValueArchiving

The EOKeyValueArchiving interface declares the methods that a class must implement so that instances of that class can be encoded and decoded with EOKeyValueArchiver and EOKeyValueUnarchiver objects.

An archiver instructs the object to encode its state by invoking encodeWithKeyValueArchiver and an unarchiver instructs an object's class to decode its state by invoking the static method decodeWithKeyValueUnarchiver which takes an EOKeyValueArchiver as argument.

The method decodeWithKeyValueUnarchiver isn't strictly part of the EOKeyValueArchiving interface, but it is required of any class that implements the interface. decodeWithKeyValueUnarchiver is a static method, and therefore can't be formally declared in the EOKeyValueArchiving interface. Any class that implements the EOKeyValueArchiving interface must implement its methods, and implement the static method decodeWithKeyValueUnarchiver. The method signature is:

  public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver unarchiver)
 

See Also:

EOKeyValueArchiver, EOKeyValueUnarchiver, EOKeyValueArchiving.Awaking, EOKeyValueArchiving.FinishInitialization, EOKeyValueArchiving.Support

Inner Class Summary

static interface	EOKeyValueArchiving.Awaking EOKeyValueArchiving.Awaking is an interface which can be optionally implemented by EOKeyValueArchiving objects if they need to be awaken explicitly at the end of an unarchiving process of an EOKeyValueUnarchiver.
static interface	EOKeyValueArchiving.FinishInitialization EOKeyValueArchiving.FinishInitialization is an interface which can be optionally implemented by EOKeyValueArchiving objects if they have special initialization needs at the end of an unarchiving process of an EOKeyValueUnarchiver.
static class	EOKeyValueArchiving.Support EOKeyValueArchiving.Support is an abstract class that defines a mechanism for one class to provide EOKeyValueArchiving behavior on behalf of another class.

Method Summary

void	encodeWithKeyValueArchiver(EOKeyValueArchiver archiver) Asks the receiver to archive its state into the EOKeyValueArchiver archiver.

Method Detail

encodeWithKeyValueArchiver

public void encodeWithKeyValueArchiver(EOKeyValueArchiver archiver)

Asks the receiver to archive its state into the EOKeyValueArchiver archiver.

Parameters:

archiver - the EOKeyValueArchiver

See Also:

EOKeyValueArchiver