View Javadoc

1   /**
2    * Copyright (c) 2008-2011, http://www.snakeyaml.org
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.yaml.snakeyaml.scanner;
18  
19  import org.yaml.snakeyaml.error.Mark;
20  import org.yaml.snakeyaml.error.MarkedYAMLException;
21  
22  /**
23   * Exception thrown by the {@link Scanner} implementations in case of malformed
24   * input.
25   */
26  public class ScannerException extends MarkedYAMLException {
27  
28      private static final long serialVersionUID = 4782293188600445954L;
29  
30      /**
31       * Constructs an instance.
32       * 
33       * @param context
34       *            Part of the input document in which vicinity the problem
35       *            occurred.
36       * @param contextMark
37       *            Position of the <code>context</code> within the document.
38       * @param problem
39       *            Part of the input document that caused the problem.
40       * @param problemMark
41       *            Position of the <code>problem</code> within the document.
42       * @param note
43       *            Message for the user with further information about the
44       *            problem.
45       */
46      public ScannerException(String context, Mark contextMark, String problem, Mark problemMark,
47              String note) {
48          super(context, contextMark, problem, problemMark, note);
49      }
50  
51      /**
52       * Constructs an instance.
53       * 
54       * @param context
55       *            Part of the input document in which vicinity the problem
56       *            occurred.
57       * @param contextMark
58       *            Position of the <code>context</code> within the document.
59       * @param problem
60       *            Part of the input document that caused the problem.
61       * @param problemMark
62       *            Position of the <code>problem</code> within the document.
63       */
64      public ScannerException(String context, Mark contextMark, String problem, Mark problemMark) {
65          this(context, contextMark, problem, problemMark, null);
66      }
67  }