View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License. 
18   */
19  package org.apache.creadur.whisker.fromxml;
20  
21  /**
22   * Indicates that the element linked by ID is missing.
23   */
24  public class MissingIDException extends InvalidXmlException {
25  
26      private static final long serialVersionUID = 2226669867694728783L;
27      private final String linkedElement;
28      private final String linkingElement;
29      private final String id;
30      
31      /**
32       * Constructs an instance.
33       * @param organisationElementName not null
34       * @param name not null
35       * @param id not null
36       */
37      public MissingIDException(final String linkedElement, final String linkingElement,
38              final String id) {
39          super("Missing ID '" + id + "' for element '" + linkedElement + "' linked from element '" + linkingElement  + "'");
40          this.linkedElement = linkedElement;
41          this.linkingElement = linkingElement;
42          this.id = id;
43      }
44  
45      /**
46       * Gets the name of the missing element linked by ID.
47       * @return not null
48       */
49      public String getLinkedElement() {
50          return linkedElement;
51      }
52  
53      /**
54       * Gets the name of the present element linked to a missing element 
55       * by an ID.
56       * @return not null
57       */
58      public String getLinkingElement() {
59          return linkingElement;
60      }
61  
62      /**
63       * Gets the ID whose linked element is missing.
64       * @return not null
65       */
66      public String getId() {
67          return id;
68      }
69  }