javax.tv.locator.InvalidLocatorException Maven / Gradle / Ivy
/**
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative use only. For example,
this file and any files generated from it may be used to generate other documentation,
such as a unified set of documents of API signatures for a platform
that includes technologies expressed as Java APIs.
This file may also be used to produce "compilation stubs,"
which allow applications to be compiled and validated for such platforms.
By contrast, no permission is given for you to incorporate this file,
in whole or in part, in an implementation of a Java specification.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 927: Java TV API 1.1.1.
In the event of a discrepency between this work and the JSR 927 specification,
which is available at http://www.jcp.org/en/jsr/detail?id=927, the latter takes precedence.
*/
package javax.tv.locator;
/**
* This exception is thrown when a Locator is not valid
* in a particular context. A Locator can be invalid or
* several reasons, including:
*
*
*
* - The
Locator refers to a resource that is not
* valid at the time of usage.
*
* - The
Locator refers to a type of resource that is
* not appropriate for usage as a particular method parameter.
*
* - The
Locator refers to a type of
* resource whose usage is not supported on this system.
*
*
*/
public class InvalidLocatorException extends Exception
{
/**
* Constructs an InvalidLocatorException with no
* detail message.
*
* @param locator The offending Locator.
*/
public InvalidLocatorException(Locator locator) { }
/**
* Constructs an InvalidLocatorException with the
* specified detail message.
*
* @param locator The offending Locator.
* @param reason The reason this Locator is invalid.
*/
public InvalidLocatorException(Locator locator, String reason) { }
/**
* Returns the offending Locator instance.
*
* @return The locator that caused the exception.
*/
public Locator getInvalidLocator() {
return null;
}
}