001/*
002 * Units of Measurement API
003 * Copyright (c) 2014-2016, Jean-Marie Dautelle, Werner Keil, V2COM.
004 *
005 * All rights reserved.
006 *
007 * Redistribution and use in source and binary forms, with or without modification,
008 * are permitted provided that the following conditions are met:
009 *
010 * 1. Redistributions of source code must retain the above copyright notice,
011 *    this list of conditions and the following disclaimer.
012 *
013 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
014 *    and the following disclaimer in the documentation and/or other materials provided with the distribution.
015 *
016 * 3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products
017 *    derived from this software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
020 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
021 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
022 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
023 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
028 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package javax.measure.format;
031
032import javax.measure.MeasurementException;
033
034/**
035 * Signals that an error has been reached unexpectedly while parsing.
036 *
037 * @author Werner Keil
038 * @version 1.0, August 8, 2016
039 * @since 1.0
040 */
041public class ParserException extends MeasurementException {
042
043  private static final long serialVersionUID = -3179553925611520368L;
044
045  /**
046   * The zero-based character position in the string being parsed at which the error was found while parsing.
047   *
048   * @serial
049   */
050  private int position;
051
052  /** The original input data. */
053  private CharSequence data;
054
055  /**
056   * Constructs a ParserException with the specified detail message, parsed text and index. A detail message is a String that describes this
057   * particular exception.
058   *
059   * @param message
060   *          the detail message
061   * @param parsedData
062   *          the parsed text, should not be null
063   * @param position
064   *          the position where the error was found while parsing.
065   */
066  public ParserException(String message, CharSequence parsedData, int position) {
067    super(message);
068    this.data = parsedData;
069    this.position = position;
070  }
071
072  /**
073   * Constructs a ParserException with the parsed text and offset. A detail message is a String that describes this particular exception.
074   *
075   * @param parsedData
076   *          the parsed text, should not be null
077   * @param position
078   *          the position where the error is found while parsing.
079   */
080  public ParserException(CharSequence parsedData, int position) {
081    this("Parse Error", parsedData, position);
082  }
083
084  /**
085   * Constructs a ParserException with the specified cause.
086   *
087   * @param cause
088   *          the root cause
089   */
090  public ParserException(Throwable cause) {
091    super(cause);
092  }
093
094  /**
095   * Returns the position where the error was found.
096   *
097   * @return the position of the error
098   */
099  public int getPosition() {
100    return position;
101  }
102
103  /**
104   * Returns the string that was being parsed.
105   *
106   * @return the parsed string, or {@code null}, if {@code null} was passed as input.
107   */
108  public String getParsedString() {
109    if (data == null)
110      return null;
111    return data.toString();
112  }
113}