1 /*
2 * ModeShape (http://www.modeshape.org)
3 * See the COPYRIGHT.txt file distributed with this work for information
4 * regarding copyright ownership. Some portions may be licensed
5 * to Red Hat, Inc. under one or more contributor license agreements.
6 * See the AUTHORS.txt file in the distribution for a full listing of
7 * individual contributors.
8 *
9 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10 * is licensed to you under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation; either version 2.1 of
12 * the License, or (at your option) any later version.
13 *
14 * ModeShape is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this software; if not, write to the Free
21 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23 */
24 package org.modeshape.graph.query.model;
25
26 import net.jcip.annotations.Immutable;
27 import org.modeshape.common.util.CheckArg;
28
29 /**
30 * A value bound to a variable name used in a {@link Comparison} constraint.
31 */
32 @Immutable
33 public class BindVariableName implements StaticOperand {
34
35 private static final long serialVersionUID = 1L;
36
37 private final String variableName;
38
39 public BindVariableName( String variableName ) {
40 CheckArg.isNotNull(variableName, "variableName");
41 this.variableName = variableName;
42 }
43
44 /**
45 * @return variableName
46 */
47 public final String variableName() {
48 return variableName;
49 }
50
51 /**
52 * {@inheritDoc}
53 *
54 * @see java.lang.Object#toString()
55 */
56 @Override
57 public String toString() {
58 return Visitors.readable(this);
59 }
60
61 /**
62 * {@inheritDoc}
63 *
64 * @see java.lang.Object#hashCode()
65 */
66 @Override
67 public int hashCode() {
68 return variableName.hashCode();
69 }
70
71 /**
72 * {@inheritDoc}
73 *
74 * @see java.lang.Object#equals(java.lang.Object)
75 */
76 @Override
77 public boolean equals( Object obj ) {
78 if (obj == this) return true;
79 if (obj instanceof BindVariableName) {
80 BindVariableName that = (BindVariableName)obj;
81 return this.variableName.equals(that.variableName);
82 }
83 return false;
84 }
85
86 /**
87 * {@inheritDoc}
88 *
89 * @see org.modeshape.graph.query.model.Visitable#accept(org.modeshape.graph.query.model.Visitor)
90 */
91 public void accept( Visitor visitor ) {
92 visitor.visit(this);
93 }
94 }