/*
 * Copyright (c) 2003, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package javax.xml.bind;

This exception indicates that a violation of a dynamically checked type 
constraint was detected.

This exception can be thrown by the generated setter methods of the schema
derived Java content classes.  However, since fail-fast validation is
an optional feature for JAXB Providers to support, not all setter methods
will throw this exception when a type constraint is violated.

If this exception is throw while invoking a fail-fast setter, the value of
the property is guaranteed to remain unchanged, as if the setter were never
called.
Author:
Ryan Shoemaker, Sun Microsystems, Inc.
Joe Fialli, Sun Microsystems, Inc.
See Also:
ValidationEvent
Since:
1.6, JAXB 1.0/**
 * This exception indicates that a violation of a dynamically checked type 
 * constraint was detected.
 *
 * <p>
 * This exception can be thrown by the generated setter methods of the schema
 * derived Java content classes.  However, since fail-fast validation is
 * an optional feature for JAXB Providers to support, not all setter methods
 * will throw this exception when a type constraint is violated.
 * 
 * <p>
 * If this exception is throw while invoking a fail-fast setter, the value of
 * the property is guaranteed to remain unchanged, as if the setter were never
 * called.
 *
 * @author <ul><li>Ryan Shoemaker, Sun Microsystems, Inc.</li><li>Joe Fialli, Sun Microsystems, Inc.</li></ul> 
 * @see ValidationEvent
 * @since 1.6, JAXB 1.0
 */

public class TypeConstraintException extends java.lang.RuntimeException {
  
    
Vendor specific error code
/** 
     * Vendor specific error code
     *
     */
    private String errorCode;

    
Exception reference
/** 
     * Exception reference
     *
     */
    private volatile Throwable linkedException;

    static final long serialVersionUID = -3059799699420143848L;

    
Construct a TypeConstraintException with the specified detail message.  The 
errorCode and linkedException will default to null.
Params:
message – a description of the exception/** 
     * Construct a TypeConstraintException with the specified detail message.  The 
     * errorCode and linkedException will default to null.
     *
     * @param message a description of the exception
     */
    public TypeConstraintException(String message) {
        this( message, null, null );
    }

    
Construct a TypeConstraintException with the specified detail message and vendor 
specific errorCode.  The linkedException will default to null.
Params:
message – a description of the exception
errorCode – a string specifying the vendor specific error code/** 
     * Construct a TypeConstraintException with the specified detail message and vendor 
     * specific errorCode.  The linkedException will default to null.
     *
     * @param message a description of the exception
     * @param errorCode a string specifying the vendor specific error code
     */
    public TypeConstraintException(String message, String errorCode) {
        this( message, errorCode, null );
    }

    
Construct a TypeConstraintException with a linkedException.  The detail message and
vendor specific errorCode will default to null.
Params:
exception – the linked exception/** 
     * Construct a TypeConstraintException with a linkedException.  The detail message and
     * vendor specific errorCode will default to null.
     *
     * @param exception the linked exception
     */
    public TypeConstraintException(Throwable exception) {
        this( null, null, exception );
    }
    
    
Construct a TypeConstraintException with the specified detail message and 
linkedException.  The errorCode will default to null.
Params:
message – a description of the exception
exception – the linked exception/** 
     * Construct a TypeConstraintException with the specified detail message and 
     * linkedException.  The errorCode will default to null.
     *
     * @param message a description of the exception
     * @param exception the linked exception
     */
    public TypeConstraintException(String message, Throwable exception) {
        this( message, null, exception );
    }
    
    
Construct a TypeConstraintException with the specified detail message,
vendor specific errorCode, and linkedException.
Params:
message – a description of the exception
errorCode – a string specifying the vendor specific error code
exception – the linked exception/** 
     * Construct a TypeConstraintException with the specified detail message,
     * vendor specific errorCode, and linkedException.
     *
     * @param message a description of the exception
     * @param errorCode a string specifying the vendor specific error code
     * @param exception the linked exception
     */
    public TypeConstraintException(String message, String errorCode, Throwable exception) {
        super( message );
        this.errorCode = errorCode;
        this.linkedException = exception;
    }
    
    
Get the vendor specific error code
Returns:
a string specifying the vendor specific error code/** 
     * Get the vendor specific error code
     *
     * @return a string specifying the vendor specific error code
     */
    public String getErrorCode() {
        return this.errorCode;
    }

    
Get the linked exception 
Returns:
the linked Exception, null if none exists/**
     * Get the linked exception 
     *
     * @return the linked Exception, null if none exists
     */
    public Throwable getLinkedException() {
        return linkedException;
    }

    
Add a linked Exception.
Params:
exception – the linked Exception (A null value is permitted and 
                 indicates that the linked exception does not exist or
                 is unknown)./**
     * Add a linked Exception.
     *
     * @param exception the linked Exception (A null value is permitted and 
     *                  indicates that the linked exception does not exist or
     *                  is unknown).
     */
    public void setLinkedException( Throwable exception ) {
        this.linkedException = exception;
    }
    
    
Returns a short description of this TypeConstraintException.
/**
     * Returns a short description of this TypeConstraintException.
     *
     */
    public String toString() {
        return linkedException == null ? 
            super.toString() :
            super.toString() + "\n - with linked exception:\n[" +
                                linkedException.toString()+ "]";
    }
 
    
Prints this TypeConstraintException and its stack trace (including the stack trace
of the linkedException if it is non-null) to the PrintStream.
Params:
s – PrintStream to use for output/**
     * Prints this TypeConstraintException and its stack trace (including the stack trace
     * of the linkedException if it is non-null) to the PrintStream.
     *
     * @param s PrintStream to use for output
     */
    public void printStackTrace( java.io.PrintStream s ) {
        if( linkedException != null ) {
          linkedException.printStackTrace(s);
          s.println("--------------- linked to ------------------");
        }

        super.printStackTrace(s);
    }
 
    
Prints this TypeConstraintException and its stack trace (including the stack trace of the linkedException if it is non-null) to System.err. /**
     * Prints this TypeConstraintException and its stack trace (including the stack trace
     * of the linkedException if it is non-null) to {@code System.err}.
     *
     */
    public void printStackTrace() {
        printStackTrace(System.err);
    }

}