com.oracle.tools.deferred.UnresolvableInstanceException Maven / Gradle / Ivy
Show all versions of oracle-tools-all Show documentation
/*
* File: UnresolvableInstanceException.java
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* The contents of this file are subject to the terms and conditions of
* the Common Development and Distribution License 1.0 (the "License").
*
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the License by consulting the LICENSE.txt file
* distributed with this file, or by consulting https://oss.oracle.com/licenses/CDDL
*
* 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 LICENSE.txt.
*
* 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]"
*/
package com.oracle.tools.deferred;
/**
* A {@link UnresolvableInstanceException} is thrown by a {@link Deferred}
* when an attempt to resolve and acquire an underlying object fails due to
* it not being available and for intensive purposes, will never become
* available, regardless of the number of retries.
*
* When this happens all attempts to acquire the object from the
* {@link Deferred} should be abandoned.
*
* Copyright (c) 2013. All Rights Reserved. Oracle Corporation.
* Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
*
* @author Brian Oliver
*/
@SuppressWarnings("serial")
public class UnresolvableInstanceException extends RuntimeException
{
/**
* The {@link Deferred} that was not available to provide a object.
*/
private transient Deferred m_deferred;
/**
* Constructs a {@link UnresolvableInstanceException} for the
* specified {@link Deferred}.
*
* @param deferred the {@link com.oracle.tools.deferred.Deferred}
*/
public UnresolvableInstanceException(Deferred deferred)
{
super(deferred.toString());
m_deferred = deferred;
}
/**
* Constructs a {@link UnresolvableInstanceException} for the
* specified {@link Deferred}, with the specified causing
* {@link Throwable}.
*
* @param deferred the {@link com.oracle.tools.deferred.Deferred}
* @param cause the {@link Throwable} that may have caused the
* object to be unavailable
*/
public UnresolvableInstanceException(Deferred deferred,
Throwable cause)
{
super(deferred.toString(), cause);
m_deferred = deferred;
}
/**
* Obtain the {@link Deferred}, for which the underlying object is not available.
*
* Note: It is possible that this method will return null
* if the {@link UnresolvableInstanceException} was serialized. A {@link String}
* representation of the {@link Deferred} is always available by
* calling {@link #getMessage()}.
*
* @return the {@link com.oracle.tools.deferred.Deferred}
*/
public Deferred getDeferred()
{
return m_deferred;
}
/**
* {@inheritDoc}
*/
@Override
public String toString()
{
return String.format("UnresolvableInstanceException: %s\n%s", getMessage(), super.toString());
}
}