01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package org.jboss.invocation;
23:
24: import java.io.Serializable;
25: import java.io.ObjectStreamException;
26:
27: /** Type safe enumeration used for to identify the payloads.
28: *
29: * @author Scott.Stark@jboss.org
30: * @version $Revision: 57209 $
31: */
32: public final class PayloadKey implements Serializable {
33: /** Serial Version Identifier. @since 1.1.4.1 */
34: private static final long serialVersionUID = 5436722659170811314L;
35:
36: /** The max ordinal value in use for the PayloadKey enums. When you add a
37: * new key enum value you must assign it an ordinal value of the current
38: * MAX_KEY_ID+1 and update the MAX_KEY_ID value.
39: */
40: private static final int MAX_KEY_ID = 3;
41:
42: /** The array of InvocationKey indexed by ordinal value of the key */
43: private static final PayloadKey[] values = new PayloadKey[MAX_KEY_ID + 1];
44:
45: /** Put me in the transient map, not part of payload. */
46: public final static PayloadKey TRANSIENT = new PayloadKey(
47: "TRANSIENT", 0);
48:
49: /** Do not serialize me, part of payload as is. */
50: public final static PayloadKey AS_IS = new PayloadKey("AS_IS", 1);
51:
52: /** Put me in the payload map. */
53: public final static PayloadKey PAYLOAD = new PayloadKey("PAYLOAD",
54: 2);
55:
56: private final transient String name;
57:
58: // this is the only value serialized
59: private final int ordinal;
60:
61: private PayloadKey(String name, int ordinal) {
62: this .name = name;
63: this .ordinal = ordinal;
64: values[ordinal] = this ;
65: }
66:
67: public String toString() {
68: return name;
69: }
70:
71: Object readResolve() throws ObjectStreamException {
72: return values[ordinal];
73: }
74: }
|