org.jsonx.DecodeException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of binding Show documentation

The JSON/Java Binding API is designed to bind JSON documents to Java objects. More specifically, the JSON/Java Binding API provides a way for JSON objects whose structure is expressed in the JSON Schema Definition Language to be parsed and marshaled, to and from Java objects of strongly-typed classes. The JSON/Java Binding API can also be used to validate JSON documents as they are parsed from text or marshaled from Java objects against a JSD. Thus, the JSON/Java Binding API is a reference implementation of the validation and binding functionalities of the JSON Schema Definition Language.

There is a newer version: 0.4.0

Show newest version

/* Copyright (c) 2016 Jsonx
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * You should have received a copy of The MIT License (MIT) along with this
 * program. If not, see .
 */

package org.jsonx;

/**
 * Signals that an error has occurred while decoding a JSON document.
 */
public class DecodeException extends Exception {
  private static final long serialVersionUID = 7087309932016830988L;

  /**
   * The zero-based character offset into the string being parsed at which the
   * error was found during parsing.
   */
  private final int errorOffset;

  /**
   * Constructs a ParseException with the specified detail message and offset. A
   * detail message is a String that describes this particular exception.
   *
   * @param message The detail message.
   * @param errorOffset The position where the error is found while parsing.
   */
  public DecodeException(final String message, final int errorOffset) {
    this(message, errorOffset, null);
  }

  public DecodeException(final Error error) {
    this(error.toString(), error.offset, null);
  }

  public DecodeException(final String message, final int errorOffset, final Throwable cause) {
    super(message != null ? message + " [errorOffset: " + errorOffset + "]" : "[errorOffset: " + errorOffset + "]", cause);
    this.errorOffset = errorOffset;
  }

  /**
   * Returns the position where the error was found.
   *
   * @return The position where the error was found.
   */
  public int getErrorOffset() {
    return errorOffset;
  }
}