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.parse;
25  
26  import org.modeshape.common.util.CheckArg;
27  
28  /**
29   * An exception signalling that a query is invalid (but typically well-formed)
30   */
31  public class InvalidQueryException extends RuntimeException {
32  
33      /**
34       */
35      private static final long serialVersionUID = 1L;
36  
37      private final String query;
38  
39      /**
40       * Create an exception with the invalid query.
41       * 
42       * @param query the query that is invalid
43       */
44      public InvalidQueryException( String query ) {
45          super();
46          this.query = query;
47      }
48  
49      /**
50       * Create an exception with the invalid query and a message.
51       * 
52       * @param query the query that is invalid
53       * @param message
54       */
55      public InvalidQueryException( String query,
56                                    String message ) {
57          super(message);
58          CheckArg.isNotNull(query, "query");
59          this.query = query;
60      }
61  
62      /**
63       * Get the XPath query that is invalid.
64       * 
65       * @return the query; never null
66       */
67      public String getQuery() {
68          return query;
69      }
70  
71  }