javax.tv.locator.InvalidLocatorException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mhp-1.1.2 Show documentation

MHP 1.1.2 stubs

The newest version!

/*
 * @(#)InvalidLocatorException.java	1.8 00/08/06
 *
 * Copyright 1998-2000 by Sun Microsystems, Inc.,
 * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
 * All rights reserved.
 * 
 * This software is the confidential and proprietary information
 * of Sun Microsystems, Inc. ("Confidential Information").  You
 * shall not disclose such Confidential Information and shall use
 * it only in accordance with the terms of the license agreement
 * you entered into with Sun.
 */

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 {

	Locator locator = null;
	
  /**
   * Constructs an InvalidLocatorException with no
   * detail message.
   *
   * @param locator The offending Locator.
   */
  public InvalidLocatorException(Locator locator) {
	super();
	this.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) {
	super(reason);
	//super(locator.toExternalForm() + ": " + reason);
	this.locator = locator;
  }

  /**
   * Returns the offending Locator instance.
   *
   * @return The locator that caused the exception.
   */
  public Locator getInvalidLocator() {
	return locator;
  }
}