← Back to branch summary

~ubuntu-branches/debian/stretch/insubstantial/stretch

« back to all changes in this revision

Viewing changes to flamingo/src/main/java/org/pushingpixels/flamingo/api/common/KeyValuePair.java

  • Committer: Package Import Robot
  • Author(s): Felix Natter
  • Date: 2016-01-18 20:58:45 UTC
  • Revision ID: package-import@ubuntu.com-20160118205845-crbmrkda61qsi5qa
Tags: upstream-7.3+dfsg2
Import upstream version 7.3+dfsg2

Show diffs side-by-side

added added

removed removed

Lines of Context:
flamingo/src/main/java/org/pushingpixels/flamingo/api/common/KeyValuePair.java
 
1
/*
 
2
 * Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
 
3
 *
 
4
 * Redistribution and use in source and binary forms, with or without 
 
5
 * modification, are permitted provided that the following conditions are met:
 
6
 * 
 
7
 *  o Redistributions of source code must retain the above copyright notice, 
 
8
 *    this list of conditions and the following disclaimer. 
 
9
 *     
 
10
 *  o Redistributions in binary form must reproduce the above copyright notice, 
 
11
 *    this list of conditions and the following disclaimer in the documentation 
 
12
 *    and/or other materials provided with the distribution. 
 
13
 *     
 
14
 *  o Neither the name of Flamingo Kirill Grouchnikov nor the names of 
 
15
 *    its contributors may be used to endorse or promote products derived 
 
16
 *    from this software without specific prior written permission. 
 
17
 *     
 
18
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 
19
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
 
20
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 
21
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
 
22
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 
23
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 
24
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
 
25
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 
26
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
 
27
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 
28
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 
29
 */
 
30
package org.pushingpixels.flamingo.api.common;
 
31
 
 
32
import java.util.*;
 
33
 
 
34
/**
 
35
 * Generic key-value pair with optional property map.
 
36
 * 
 
37
 * @author Kirill Grouchnikov
 
38
 * @param <S>
 
39
 *            Key class.
 
40
 * @param <T>
 
41
 *            Value class.
 
42
 */
 
43
public class KeyValuePair<S, T> {
 
44
        /**
 
45
         * Pair key.
 
46
         */
 
47
        protected S key;
 
48
 
 
49
        /**
 
50
         * Pair value.
 
51
         */
 
52
        protected T value;
 
53
 
 
54
        /**
 
55
         * Property map.
 
56
         */
 
57
        protected Map<String, Object> propMap;
 
58
 
 
59
        /**
 
60
         * Creates a new pair.
 
61
         * 
 
62
         * @param key
 
63
         *            Pair key.
 
64
         * @param value
 
65
         *            Pair value.
 
66
         */
 
67
        public KeyValuePair(S key, T value) {
 
68
                this.key = key;
 
69
                this.value = value;
 
70
                this.propMap = new HashMap<String, Object>();
 
71
        }
 
72
 
 
73
        /**
 
74
         * Returns the pair value.
 
75
         * 
 
76
         * @return Pair value.
 
77
         */
 
78
        public T getValue() {
 
79
                return value;
 
80
        }
 
81
 
 
82
        /**
 
83
         * Returns the pair key.
 
84
         * 
 
85
         * @return Pair key.
 
86
         */
 
87
        public S getKey() {
 
88
                return key;
 
89
        }
 
90
 
 
91
        /**
 
92
         * Returns the property attached to the specified key.
 
93
         * 
 
94
         * @param propKey
 
95
         *            Property key.
 
96
         * @return Attached property.
 
97
         */
 
98
        public Object get(String propKey) {
 
99
                return this.propMap.get(propKey);
 
100
        }
 
101
 
 
102
        /**
 
103
         * Sets the property specified by the key and value.
 
104
         * 
 
105
         * @param propKey
 
106
         *            Property key.
 
107
         * @param propValue
 
108
         *            Property value.
 
109
         */
 
110
        public void set(String propKey, Object propValue) {
 
111
                this.propMap.put(propKey, propValue);
 
112
        }
 
113
 
 
114
        /**
 
115
         * Returns all attached properties.
 
116
         * 
 
117
         * @return All attached properties.
 
118
         */
 
119
        public Map<String, Object> getProps() {
 
120
                return Collections.unmodifiableMap(this.propMap);
 
121
        }
 
122
}
 
 
b'\\ No newline at end of file'