summaryrefslogtreecommitdiff
path: root/src/main/java/com/amazon/carbonado/qe/QueryHints.java
blob: 607921fee66530589c4943954d90d0f72e46a13e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
 * Copyright 2008 Amazon Technologies, Inc. or its affiliates.
 * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
 * of Amazon Technologies, Inc. or its affiliates.  All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.amazon.carbonado.qe;

import java.util.EnumMap;

/**
 * An immutable map of query hints.
 *
 * @author Brian S O'Neill
 * @see QueryHint
 * @since 1.2
 */
public class QueryHints implements java.io.Serializable {
    private static final long serialVersionUID = 1L;
    private static final QueryHints EMPTY_HINTS = new QueryHints(null);

    public static QueryHints emptyHints() {
        return EMPTY_HINTS;
    }

    private final EnumMap<QueryHint, Object> mMap;

    private QueryHints(EnumMap<QueryHint, Object> map) {
        mMap = map;
    }

    /**
     * Returns a new QueryHints object with the given hint. The associated
     * value is the hint object itself.
     *
     * @throws IllegalArgumentException if hint is null
     */
    public QueryHints with(QueryHint hint) {
        return with(hint, hint);
    }

    /**
     * Returns a new QueryHints object with the given hint and value.
     *
     * @throws IllegalArgumentException if hint or value is null
     */
    public QueryHints with(QueryHint hint, Object value) {
        if (hint == null) {
            throw new IllegalArgumentException("Null hint");
        }
        if (value == null) {
            throw new IllegalArgumentException("Null value");
        }
        EnumMap<QueryHint, Object> map;
        if (mMap == null) {
            map = new EnumMap<QueryHint, Object>(QueryHint.class);
        } else {
            map = mMap.clone();
        }
        map.put(hint, value);
        return new QueryHints(map);
    }

    /**
     * Returns a new QueryHints object without the given hint.
     */
    public QueryHints without(QueryHint hint) {
        if (hint == null || mMap == null || !mMap.containsKey(hint)) {
            return this;
        }
        EnumMap<QueryHint, Object> map = mMap.clone();
        map.remove(hint);
        if (map.size() == 0) {
            map = null;
        }
        return new QueryHints(map);
    }

    /**
     * Returns false if hint is not provided.
     */
    public boolean contains(QueryHint hint) {
        return get(hint) != null;
    }

    /**
     * Returns null if hint is not provided.
     */
    public Object get(QueryHint hint) {
        return hint == null ? null : (mMap == null ? null : mMap.get(hint));
    }

    public boolean isEmpty() {
        return mMap == null ? true : mMap.isEmpty();
    }

    @Override
    public int hashCode() {
        return mMap == null ? 0 : mMap.hashCode();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj instanceof QueryHints) {
            QueryHints other = (QueryHints) obj;
            if (mMap == null) {
                return other.mMap == null;
            } else {
                return mMap.equals(other.mMap);
            }
        }
        return false;
    }

    @Override
    public String toString() {
        if (mMap == null) {
            return "QueryHints: {}";
        }
        return "QueryHints: " + mMap;
    }
}