01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: *
19: */
20: package org.apache.mina.statemachine.context;
21:
22: import org.apache.mina.statemachine.State;
23: import org.apache.mina.statemachine.StateMachine;
24:
25: /**
26: * {@link StateContext} objects are used to store the current {@link State} and
27: * any application specific attributes for a specific client of a
28: * {@link StateMachine}. Since {@link StateMachine}s are singletons and shared
29: * by all clients using the {@link StateMachine} this is where client specific
30: * data needs to be stored.
31: *
32: * @author The Apache MINA Project (dev@mina.apache.org)
33: * @version $Rev: 586695 $, $Date: 2007-10-20 04:01:17 -0600 (Sat, 20 Oct 2007) $
34: */
35: public interface StateContext {
36: /**
37: * Returns the current {@link State}. This is only meant for internal use.
38: *
39: * @return the current {@link State}.
40: */
41: State getCurrentState();
42:
43: /**
44: * Sets the current {@link State}. This is only meant for internal use.
45: * Don't call it directly!
46: *
47: * @param state the new current {@link State}.
48: */
49: void setCurrentState(State state);
50:
51: /**
52: * Returns the value of the attribute with the specified key or
53: * <code>null</code>if not found.
54: *
55: * @param key the key.
56: * @return the value or <code>null</code>.
57: */
58: Object getAttribute(Object key);
59:
60: /**
61: * Sets the value of the attribute with the specified key.
62: *
63: * @param key the key.
64: * @param value the value.
65: */
66: void setAttribute(Object key, Object value);
67: }
|