View Javadoc

1   /* This file is part of COPAL (COntext Provisioning for All).
2    *
3    * COPAL is a part of SM4All (Smart hoMes for All) project.
4    *
5    * COPAL is free software: you can redistribute it and/or modify
6    * it under the terms of the GNU Lesser General Public License as published by
7    * the Free Software Foundation, either version 3 of the License, or
8    * (at your option) any later version.
9    *
10   * COPAL is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   * GNU Lesser General Public License for more details.
14   *
15   * You should have received a copy of the GNU Lesser General Public License
16   * along with COPAL. If not, see <http://www.gnu.org/licenses/>.
17   */
18  package at.ac.tuwien.infosys.sm4all.copal.api.query;
19  
20  import java.text.MessageFormat;
21  import at.ac.tuwien.infosys.sm4all.copal.api.ContextException;
22  
23  /**
24   * Exception when a destroyed {@link ContextQuery} is used.
25   * 
26   * @author sanjin
27   */
28  public class QueryDestroyedException extends ContextException {
29  
30      private static final long serialVersionUID = -2807042155665815201L;
31  
32      private final ContextQuery query;
33  
34      /**
35       * Create instance of specified {@link ContextQuery} is destroyed exception.
36       * The cause is not initialized, and may subsequently be initialized by a
37       * call to {@link #initCause(Throwable)}.
38       * 
39       * @param query the destroyed {@link ContextQuery} (which is saved for later
40       *        retrieval by the {@link #getQuery()} method).
41       */
42      public QueryDestroyedException(final ContextQuery query) {
43          super(MessageFormat.format("Query ''{0}'' is destroyed.",
44                  query.getName()));
45  
46          this.query = query;
47      }
48  
49      /**
50       * Returns the destroyed {@link ContextQuery}.
51       * 
52       * @return the destroyed {@link ContextQuery}.
53       */
54      public ContextQuery getQuery() {
55          return this.query;
56      }
57  }