##### Coverage Report - com.sun.grizzly.util.AttributeHolder

Classes in this File | Line Coverage | Branch Coverage | Complexity
AttributeHolder |
N/A | N/A
N/A | N/A
| 0.0;0

1 |  |
     /*
2 |  |
      *
3 |  |
      * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 |  |
      *
5 |  |
      * Copyright 2007-2008 Sun Microsystems, Inc. All rights reserved.
6 |  |
      *
7 |  |
      * The contents of this file are subject to the terms of either the GNU
8 |  |
      * General Public License Version 2 only ("GPL") or the Common Development
9 |  |
      * and Distribution License("CDDL") (collectively, the "License").  You
10 |  |
      * may not use this file except in compliance with the License. You can obtain
11 |  |
      * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
12 |  |
      * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
13 |  |
      * language governing permissions and limitations under the License.
14 |  |
      *
15 |  |
      * When distributing the software, include this License Header Notice in each
16 |  |
      * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
17 |  |
      * Sun designates this particular file as subject to the "Classpath" exception
18 |  |
      * as provided by Sun in the GPL Version 2 section of the License file that
19 |  |
      * accompanied this code.  If applicable, add the following below the License
20 |  |
      * Header, with the fields enclosed by brackets [] replaced by your own
21 |  |
      * identifying information: "Portions Copyrighted [year]
22 |  |
      * [name of copyright owner]"
23 |  |
      *
24 |  |
      * Contributor(s):
25 |  |
      *
26 |  |
      * If you wish your version of this file to be governed by only the CDDL or
27 |  |
      * only the GPL Version 2, indicate your decision by adding "[Contributor]
28 |  |
      * elects to include this software in this distribution under the [CDDL or GPL
29 |  |
      * Version 2] license."  If you don't indicate a single choice of license, a
30 |  |
      * recipient has the option to distribute your version of this file under
31 |  |
      * either the CDDL, the GPL Version 2 or to extend the choice of license to
32 |  |
      * its licensees as provided above.  However, if you add GPL Version 2 code
33 |  |
      * and therefore, elected the GPL Version 2 license, then the option applies
34 |  |
      * only if the new code is made subject to such option by the copyright
35 |  |
      * holder.
36 |  |
      *
37 |  |
      */
38 |  |
39 |  |
     package com.sun.grizzly.util;
40 |  |
41 |  |
     import java.util.Map;
42 |  |
43 |  |
     /**
44 |  |
      * Interface declares common functionality for objects, which could have
45 |  |
      * associated attributes.
46 |  |
      *
47 |  |
      * @author Alexey Stashok
48 |  |
      */
49 |  |
     public interface AttributeHolder {
50 |  |
         /**
51 |  |
          * Remove a name/value object.
52 |  |
          * @param name - name of an attribute
53 |  |
          * @return  attribute which has been removed
54 |  |
          */
55 |  |
         public Object removeAttribute(String name);
56 |  |
57 |  |
58 |  |
         /**
59 |  |
          * Set a name/value object.
60 |  |
          * @param name - name of an attribute
61 |  |
          * @param value - value of named attribute
62 |  |
          */
63 |  |
         public void setAttribute(String name, Object value);
64 |  |
65 |  |
66 |  |
         /**
67 |  |
          * Set a {@link Map} of attribute name/value pairs.
68 |  |
          * Old {@link AttributeHolder} values will not be available.
69 |  |
          * Later changes of this {@link Map} will lead to changes to the current
70 |  |
          * {@link AttributeHolder}.
71 |  |
          *
72 |  |
          * @param attributes - map of name/value pairs
73 |  |
          */
74 |  |
         public void setAttributes(Map<String, Object> attributes);
75 |  |
76 |  |
77 |  |
         /**
78 |  |
          * Return an object based on a name.
79 |  |
          * @param name - name of an attribute
80 |  |
          * @return - attribute value for the <tt>name</tt>, null if <tt>name</tt>
81 |  |
          *           does not exist in <tt>attributes</tt>
82 |  |
          */
83 |  |
         public Object getAttribute(String name);
84 |  |
85 |  |
86 |  |
         /**
87 |  |
          * Return a {@link Map} of attribute name/value pairs.
88 |  |
          * Updates, performed on the returned {@link Map} will be reflected in
89 |  |
          * this {@link AttributeHolder}
90 |  |
          *
91 |  |
          * @return - {@link Map} of attribute name/value pairs
92 |  |
          */
93 |  |
         public Map<String, Object> getAttributes();
94 |  |
     }