StateObjectManager


1   // Copyright 2005 The Apache Software Foundation
2   //
3   // Licensed under the Apache License, Version 2.0 (the "License");
4   // you may not use this file except in compliance with the License.
5   // You may obtain a copy of the License at
6   //
7   //     http://www.apache.org/licenses/LICENSE-2.0
8   //
9   // Unless required by applicable law or agreed to in writing, software
10  // distributed under the License is distributed on an "AS IS" BASIS,
11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  // See the License for the specific language governing permissions and
13  // limitations under the License.
14  
15  package org.apache.tapestry.engine.state;
16  
17  /**
18   * Interface for an object that manages a single application state object. Represents the named
19   * intersection of a {@link org.apache.tapestry.engine.state.StateObjectPersistenceManager}for
20   * storing the state object between request cycles, and a
21   * {@link org.apache.tapestry.engine.state.StateObjectFactory}to create the object in the first
22   * place.
23   * 
24   * @author Howard M. Lewis Ship
25   * @since 4.0
26   */
27  public interface StateObjectManager
28  {
29      /**
30       * Returns true if the application state object exists (i.e., a value has been stored).
31       */
32      public boolean exists();
33  
34      /**
35       * Gets or creates the application state object.
36       */
37  
38      public Object   get();
39  
40      /**
41       * Stores (if necessary) the object back into persistent storage. This is not application to all
42       * storage scopes.
43       * 
44       * @param stateObject
45       *            the application state object previously obtained from {@link #get()}.
46       */
47  
48      public void store(Object   stateObject);
49  }

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags