KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > aop > util > PayloadKey


1 /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * 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.aop.util;
23
24 import java.io.ObjectStreamException JavaDoc;
25 import java.io.Serializable JavaDoc;
26 import java.util.ArrayList JavaDoc;
27
28 /**
29  * Type safe enumeration used for to identify the payloads.
30  */

31 public final class PayloadKey implements Serializable JavaDoc
32 {
33
34    static final long serialVersionUID = 7688683906350419871L;
35
36    // these fields are used for serialization
37
private static int nextOrdinal = 0;
38
39    private static final ArrayList JavaDoc values = new ArrayList JavaDoc(3);
40
41    /** Put me in the transient map, not part of payload. */
42    public final static PayloadKey TRANSIENT = new PayloadKey("TRANSIENT");
43
44    /** Do not serialize me, part of payload as is. */
45    public final static PayloadKey AS_IS = new PayloadKey("AS_IS");
46
47    /** Put me in the payload map. */
48    public final static PayloadKey MARSHALLED = new PayloadKey("MARSHALLED");
49
50    private final transient String JavaDoc name;
51
52    // this is the only value serialized
53
private final int ordinal;
54
55    private PayloadKey(String JavaDoc name)
56    {
57       this.name = name;
58       this.ordinal = nextOrdinal++;
59       values.add(this);
60    }
61
62    public String JavaDoc toString()
63    {
64       return name;
65    }
66
67    Object JavaDoc readResolve() throws ObjectStreamException JavaDoc
68    {
69       return values.get(ordinal);
70    }
71 }
72
Popular Tags