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 0.5, $Date: 2016-02-12 $
039 */
040public class ParserException extends MeasurementException {
041
042  private static final long serialVersionUID = -3179553925611520368L;
043
044  /**
045   * The zero-based character position in the string being parsed at which the error was found while parsing.
046   *
047   * @serial
048   */
049  private int position;
050
051  /** The original input data. */
052  private CharSequence data;
053
054  /**
055   * Constructs a ParserException with the specified detail message, parsed text and index. A detail message is a String that describes this
056   * particular exception.
057   *
058   * @param message
059   *          the detail message
060   * @param parsedData
061   *          the parsed text, should not be null
062   * @param position
063   *          the position where the error was found while parsing.
064   */
065  public ParserException(String message, CharSequence parsedData, int position) {
066    super(message);
067    this.data = parsedData;
068    this.position = position;
069  }
070
071  /**
072   * Constructs a ParserException with the parsed text and offset. A detail message is a String that describes this particular exception.
073   *
074   * @param parsedData
075   *          the parsed text, should not be null
076   * @param position
077   *          the position where the error is found while parsing.
078   */
079  public ParserException(CharSequence parsedData, int position) {
080    this("Parse Error", parsedData, position);
081  }
082
083  /**
084   * Constructs a ParserException with the specified cause.
085   *
086   * @param cause
087   *          the root cause
088   */
089  public ParserException(Throwable cause) {
090    super(cause);
091  }
092
093  /**
094   * Returns the position where the error was found.
095   *
096   * @return the position of the error
097   */
098  public int getPosition() {
099    return position;
100  }
101
102  /**
103   * Returns the string that was being parsed.
104   *
105   * @return the parsed string, or {@code null}, if {@code null} was passed as input.
106   */
107  public String getParsedString() {
108    if (data == null)
109      return null;
110    return data.toString();
111  }
112}