com.agical.rmock.core.documentation
Interface Context


public interface Context

An interface for a documentation context. The documentation context stores information about the test, both runtime and static. Anything stored on the context must be serializable so that the data can be stored for later retrieval when building a document incrementally.

The data on the context is stored for a very short time typicallly form one build to another so it is not necesary to come up with any fancy serialization strategies. Out of the box serialization should do just fine.

(c) 2005 Agical AB

Author:
joakim.ohlrogge

Method Summary
 java.io.Serializable get(java.lang.String key)
          Gets an object from the context
 void put(java.lang.String key, java.io.Serializable object)
          Puts an object on the context
 

Method Detail

put

void put(java.lang.String key,
         java.io.Serializable object)
Puts an object on the context

Parameters:
key - The key to store the object under. Must be unique for the current test.
object - The object to store

get

java.io.Serializable get(java.lang.String key)
Gets an object from the context

Parameters:
key - The key to store the object under. Must be unique for the current test.
Returns:
The object stored under the key or null if no object was found.


Copyright © 2005-2011 Agical AB. All Rights Reserved.