javax.enterprise.concurrent.SkippedException Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2018 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.enterprise.concurrent;
import java.io.Serializable;
import java.util.concurrent.ExecutionException;
/**
* Exception indicating that the result of a value-producing task cannot be
* retrieved because the task run was skipped. A task can be skipped if the
* {@link Trigger#skipRun(javax.enterprise.concurrent.LastExecution, java.util.Date)}
* method returns true or if it throws an unchecked exception.
*
* Use the {@link Throwable#getCause()} method to determine if an unchecked
* exception was thrown from the Trigger.
*
* @since 1.0
*/
public class SkippedException extends ExecutionException implements Serializable {
/**
*
*/
private static final long serialVersionUID = 6296866815328432550L;
/**
* Constructs an SkippedException with null as its detail message. The cause is not
* initialized, and may subsequently be initialized by a call to
* {@link Throwable#initCause(java.lang.Throwable)}.
*/
public SkippedException() {
super();
}
/**
* Constructs an SkippedException exception with the specified detail message.
*
* The cause is not initialized, and may subsequently be initialized by a
* call to {@link Throwable#initCause(java.lang.Throwable)}.
*
* @param message the detail message (which is saved for later retrieval by
* the {@link Throwable#getMessage()} method).
*/
public SkippedException(java.lang.String message) {
super(message);
}
/**
* Constructs an SkippedException exception with the specified detail message
* and cause.
*
* Note that the detail message associated with cause is not automatically
* incorporated in this exception's detail message.
*
* @param message the detail message (which is saved for later retrieval by
* the {@link Throwable#getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
* {@link Throwable#getCause()} method).
* (A null value is permitted, and indicates that the cause is
* nonexistent or unknown.)
*/
public SkippedException(java.lang.String message,
java.lang.Throwable cause) {
super(message, cause);
}
/**
* Constructs an SkippedException exception with the specified cause and a
* detail message of (cause==null ? null : cause.toString())
* (which typically contains the class and detail message of cause).
*
* @param cause the cause (which is saved for later retrieval by the
* {@link Throwable#getCause()} method).
* (A null value is permitted, and indicates that the cause is
* nonexistent or unknown.)
*/
public SkippedException(java.lang.Throwable cause) {
super(cause);
}
}