01: /*
02: * <copyright>
03: *
04: * Copyright 1997-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:
27: package org.cougaar.core.util;
28:
29: import java.io.IOException;
30: import java.io.ObjectOutputStream;
31:
32: /**
33: * A {@link UniqueObject} that records the allocation stack and
34: * complains if the {@link UID} is reset.
35: */
36: public abstract class SimpleUniqueObject implements UniqueObject {
37: /** The UID of the object */
38: protected UID uid;
39:
40: /**
41: * DEBUGGING
42: * @deprecated Should be turned off
43: */
44: private transient Throwable allocationContext;
45:
46: protected SimpleUniqueObject() {
47: allocationContext = new Throwable("Allocation context");
48: }
49:
50: /**
51: * @return the UID of a UniqueObject. If the object was created
52: * correctly (e.g. via a Factory), will be non-null.
53: */
54: public UID getUID() {
55: if (uid == null) {
56: uidError("uid was never set");
57: }
58: return uid;
59: }
60:
61: /**
62: * Set the UID of a UniqueObject. This should only be done by
63: * a domain factory. Will throw a RuntimeException if
64: * the UID was already set.
65: */
66: public void setUID(UID newUID) {
67: if (uid != null && !uid.equals(newUID)) {
68: uidError("uid already set");
69: }
70: allocationContext = new Throwable("setUID context");
71: uid = newUID;
72: }
73:
74: private void uidError(String reason) {
75: if (allocationContext != null) {
76: allocationContext.printStackTrace();
77: } else {
78: System.err.println("UniqueObject deserialized");
79: }
80: throw new RuntimeException(reason + ": " + this );
81: }
82:
83: private void writeObject(ObjectOutputStream stream)
84: throws IOException {
85: if (uid == null) {
86: uidError("writeObject with no uid");
87: }
88: stream.defaultWriteObject();
89: }
90: }
|