001/*
002 * Units of Measurement API
003 * Copyright (c) 2014-2018, Jean-Marie Dautelle, Werner Keil, Otavio Santana.
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-385 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.1, March 27, 2018
039 * @since 2.0
040 */
041public class MeasurementParseException extends MeasurementException {
042
043  /**
044   * 
045   */
046  private static final long serialVersionUID = 2727457045794254852L;
047
048  /**
049   * The zero-based character position in the string being parsed at which the error was found while parsing.
050   *
051   * @serial
052   */
053  private int position;
054
055  /** The original input data. */
056  private CharSequence data;
057
058  /**
059   * Constructs a MeasurementParseException with the specified detail message, parsed text and index. A detail message is a String that describes this
060   * particular exception.
061   *
062   * @param message
063   *          the detail message
064   * @param parsedData
065   *          the parsed text, should not be null
066   * @param position
067   *          the position where the error was found while parsing.
068   */
069  public MeasurementParseException(String message, CharSequence parsedData, int position) {
070    super(message);
071    this.data = parsedData;
072    this.position = position;
073  }
074
075  /**
076   * Constructs a MeasurementParseException with the parsed text and offset. A detail message is a String that describes this particular exception.
077   *
078   * @param parsedData
079   *          the parsed text, should not be null
080   * @param position
081   *          the position where the error is found while parsing.
082   */
083  public MeasurementParseException(CharSequence parsedData, int position) {
084    this("Parse Error", parsedData, position);
085  }
086
087  /**
088   * Constructs a MeasurementParseException with the specified cause.
089   *
090   * @param cause
091   *          the root cause
092   */
093  public MeasurementParseException(Throwable cause) {
094    super(cause);
095  }
096
097  /**
098   * Constructs a MeasurementParseException with the specified detail message.
099   *
100   * @param message
101   *          the detail message
102   */
103  public MeasurementParseException(String message) {
104    super(message);
105  }
106
107  /**
108   * Returns the position where the error was found.
109   *
110   * @return the position of the error
111   */
112  public int getPosition() {
113    return position;
114  }
115
116  /**
117   * Returns the string that was being parsed.
118   *
119   * @return the parsed string, or {@code null}, if {@code null} was passed as input.
120   */
121  public String getParsedString() {
122    if (data == null)
123      return null;
124    return data.toString();
125  }
126}