01: /*
02: * <copyright>
03: *
04: * Copyright 2000-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26: package org.cougaar.core.component;
27:
28: /**
29: * A tuple containing a Component description and the Component's state.
30: *
31: * @see StateObject
32: */
33: public final class StateTuple implements java.io.Serializable {
34: private final ComponentDescription cd;
35: private final Object state;
36:
37: public StateTuple(ComponentDescription cd, Object state) {
38: this .cd = cd;
39: this .state = state;
40: if (cd == null) {
41: throw new IllegalArgumentException(
42: "ComponentDescription is null");
43: }
44: // okay for state to be null
45: }
46:
47: /**
48: * Get the ComponentDescription.
49: */
50: public ComponentDescription getComponentDescription() {
51: return cd;
52: }
53:
54: /**
55: * Get the state for the Component.
56: * <p>
57: * The state refers to the state of the Component specified
58: * in the descriptor, including any child Components.
59: */
60: public Object getState() {
61: return state;
62: }
63:
64: public String toString() {
65: return "Tuple {"
66: + cd
67: + ", "
68: + ((state != null) ? state.getClass().getName()
69: : "null") + "}";
70: }
71: }
|