View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
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.core.session;
21  
22  import java.io.Serializable;
23  import java.util.Map;
24  
25  /**
26   * A key that makes its parent {@link Map} or session attribute to search
27   * fast while being debug-friendly by providing the string representation.
28   *
29   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
30   */
31  public final class AttributeKey implements Serializable {
32      /** The serial version UID */
33      private static final long serialVersionUID = -583377473376683096L;
34      
35      /** The attribute's name */
36      private final String name;
37  
38      /**
39       * Creates a new instance. It's built from :
40       * - the class' name
41       * - the attribute's name
42       * - this attribute hashCode
43       */
44      public AttributeKey(Class<?> source, String name) {
45          this.name = source.getName() + '.' + name + '@' + Integer.toHexString(this.hashCode());
46      }
47  
48      /**
49       * The String representation of tis objection is its constructed name.
50       */
51      @Override
52      public String toString() {
53          return name;
54      }
55  }