View Javadoc
1   /*
2    * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  /*
27   * This file is available under and governed by the GNU General Public
28   * License version 2 only, as published by the Free Software Foundation.
29   * However, the following notice accompanied the original version of this
30   * file:
31   *
32   * Copyright (c) 2008-2012, Stephen Colebourne & Michael Nascimento Santos
33   *
34   * All rights reserved.
35   *
36   * Redistribution and use in source and binary forms, with or without
37   * modification, are permitted provided that the following conditions are met:
38   *
39   *  * Redistributions of source code must retain the above copyright notice,
40   *    this list of conditions and the following disclaimer.
41   *
42   *  * Redistributions in binary form must reproduce the above copyright notice,
43   *    this list of conditions and the following disclaimer in the documentation
44   *    and/or other materials provided with the distribution.
45   *
46   *  * Neither the name of JSR-310 nor the names of its contributors
47   *    may be used to endorse or promote products derived from this software
48   *    without specific prior written permission.
49   *
50   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
54   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
55   * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
56   * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
57   * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
58   * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
59   * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
60   * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61   */
62  package java.time.format;
63  
64  import java.time.DateTimeException;
65  
66  /**
67   * An exception thrown when an error occurs during parsing.
68   * <p>
69   * This exception includes the text being parsed and the error index.
70   *
71   * @implSpec
72   * This class is intended for use in a single thread.
73   *
74   * @since 1.8
75   */
76  public class DateTimeParseException extends DateTimeException {
77  
78      /**
79       * Serialization version.
80       */
81      private static final long serialVersionUID = 4304633501674722597L;
82  
83      /**
84       * The text that was being parsed.
85       */
86      private final String parsedString;
87      /**
88       * The error index in the text.
89       */
90      private final int errorIndex;
91  
92      /**
93       * Constructs a new exception with the specified message.
94       *
95       * @param message  the message to use for this exception, may be null
96       * @param parsedData  the parsed text, should not be null
97       * @param errorIndex  the index in the parsed string that was invalid, should be a valid index
98       */
99      public DateTimeParseException(String message, CharSequence parsedData, int errorIndex) {
100         super(message);
101         this.parsedString = parsedData.toString();
102         this.errorIndex = errorIndex;
103     }
104 
105     /**
106      * Constructs a new exception with the specified message and cause.
107      *
108      * @param message  the message to use for this exception, may be null
109      * @param parsedData  the parsed text, should not be null
110      * @param errorIndex  the index in the parsed string that was invalid, should be a valid index
111      * @param cause  the cause exception, may be null
112      */
113     public DateTimeParseException(String message, CharSequence parsedData, int errorIndex, Throwable cause) {
114         super(message, cause);
115         this.parsedString = parsedData.toString();
116         this.errorIndex = errorIndex;
117     }
118 
119     //-----------------------------------------------------------------------
120     /**
121      * Returns the string that was being parsed.
122      *
123      * @return the string that was being parsed, should not be null.
124      */
125     public String getParsedString() {
126         return parsedString;
127     }
128 
129     /**
130      * Returns the index where the error was found.
131      *
132      * @return the index in the parsed string that was invalid, should be a valid index
133      */
134     public int getErrorIndex() {
135         return errorIndex;
136     }
137 
138 }