View Javadoc

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 java.io.Serializable;
27  import java.util.Collections;
28  import java.util.LinkedHashSet;
29  import java.util.Set;
30  import net.jcip.annotations.Immutable;
31  import org.modeshape.common.util.CheckArg;
32  
33  /**
34   * A representation of a qualified or expanded name.
35   */
36  @Immutable
37  public class SelectorName implements Readable, Serializable {
38      private static final long serialVersionUID = 1L;
39  
40      private final String name;
41  
42      public SelectorName( String name ) {
43          CheckArg.isNotEmpty(name, "name");
44          this.name = name;
45      }
46  
47      /**
48       * The raw name of the selector.
49       * 
50       * @return the raw name; never null and never empty
51       */
52      public String name() {
53          return name;
54      }
55  
56      /**
57       * {@inheritDoc}
58       * 
59       * @see org.modeshape.graph.query.model.Readable#getString()
60       */
61      public String getString() {
62          return name;
63      }
64  
65      /**
66       * {@inheritDoc}
67       * 
68       * @see java.lang.Object#toString()
69       */
70      @Override
71      public String toString() {
72          return name;
73      }
74  
75      /**
76       * {@inheritDoc}
77       * 
78       * @see java.lang.Object#hashCode()
79       */
80      @Override
81      public int hashCode() {
82          return this.name.hashCode();
83      }
84  
85      /**
86       * {@inheritDoc}
87       * 
88       * @see java.lang.Object#equals(java.lang.Object)
89       */
90      @Override
91      public boolean equals( Object obj ) {
92          if (obj == this) return true;
93          if (obj instanceof SelectorName) {
94              SelectorName that = (SelectorName)obj;
95              return this.name.equals(that.name());
96          }
97          return false;
98      }
99  
100     public static Set<SelectorName> nameSetFrom( SelectorName name ) {
101         return Collections.singleton(name);
102     }
103 
104     public static Set<SelectorName> nameSetFrom( SelectorName firstName,
105                                                  SelectorName... names ) {
106         Set<SelectorName> result = new LinkedHashSet<SelectorName>();
107         result.add(firstName);
108         for (SelectorName name : names) {
109             if (name != null) result.add(name);
110         }
111         return Collections.unmodifiableSet(result);
112     }
113 
114     public static Set<SelectorName> nameSetFrom( Set<SelectorName> firstSet,
115                                                  Set<SelectorName> secondSet ) {
116         Set<SelectorName> result = new LinkedHashSet<SelectorName>();
117         result.addAll(firstSet);
118         if (secondSet != null) result.addAll(secondSet);
119         return Collections.unmodifiableSet(result);
120     }
121 }