com.oracle.tools.deferred.NeverAvailable Maven / Gradle / Ivy

Go to download
/*
 * File: NeverAvailable.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 NeverAvailable} is a specialized {@link Deferred} that always
 * throws an {@link UnresolvableInstanceException} when attempting to call
 * {@link #get()}.
 * 
 * Copyright (c) 2012. All Rights Reserved. Oracle Corporation.

 * Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 *
 * @author Brian Oliver
 */
public class NeverAvailable implements Deferred
{
    /**
     * The class of the {@link Deferred} object.
     */
    private Class m_deferredClass;


    /**
     * Constructor for a {@link NeverAvailable} reference.
     *
     * @param deferredClass
     */
    public NeverAvailable(Class deferredClass)
    {
        m_deferredClass = deferredClass;
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public T get() throws UnresolvableInstanceException, InstanceUnavailableException
    {
        throw new UnresolvableInstanceException(this);
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public Class getDeferredClass()
    {
        return m_deferredClass;
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public String toString()
    {
        return String.format("NeverAvailable<%s>", getDeferredClass());
    }
}