Commit f330596b authored by ocaptst_build's avatar ocaptst_build

Tagging the correct javax stubs from the trunk for the 1.1.4 release

parent 48833567
/**
<p>This is not an official specification document, and usage is restricted.
</p>
<a name="notice"><strong><center>
NOTICE
</center></strong><br>
<br>
(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
<p>
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.
<p>
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.
<p>
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
<p>
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.media;
import java.awt.Component;
/**
* <code>CachingControl</code> is an interface supported by <code>Players</code>
* that are capable of reporting download progress.
* Typically, this control is accessed through
* the <code>Controller.getControls</code> method.
*
* A <code>Controller</code> that supports this control will post
* <code>CachingControlEvents</code> often enough to support the implementation
* of custom progress GUIs.
*
* @see Controller
* @see ControllerListener
* @see CachingControlEvent
* @see Player
* @version 1.18, 97/08/25.
*/
public interface CachingControl extends Control
{
/**
* Use to indicate that the <CODE>CachingControl</CODE> doesn't
* know how long the content is.<p>
* The definition is: LENGTH_UNKNOWN == Long.MAX_VALUE
*/
public static final long LENGTH_UNKNOWN = 9223372036854775807L;
/**
* Check whether or not media is being downloaded.
*
* @return Returns <CODE>true</CODE> if media is being downloaded;
* otherwise returns <CODE>false</CODE>.
*.
*/
public boolean isDownloading();
/**
* Get the total number of bytes in the media being downloaded. Returns
* <code>LENGTH_UNKNOWN</code> if this information is not available.
*
* @return The media length in bytes, or <code>LENGTH_UNKNOWN</code>.
*/
public long getContentLength();
/**
* Get the total number of bytes of media data that have been downloaded so far.
*
* @return The number of bytes downloaded.
*/
public long getContentProgress();
/**
* Get a <CODE>Component</CODE> for displaying the download progress.
*
* @return Progress bar GUI.
*/
public Component getProgressBarComponent();
/**
* Get a <CODE>Component</CODE> that provides additional download control.
*
* Returns <CODE>null</CODE> if only a progress bar is provided.
*
* @return Download control GUI.
*/
public Component getControlComponent();
}
/**
<p>This is not an official specification document, and usage is restricted.
</p>
<a name="notice"><strong><center>
NOTICE
</center></strong><br>
<br>
(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
<p>
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.
<p>
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.
<p>
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
<p>
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.media;
/**
* This event is generated by a <CODE>Controller</CODE> that supports
* the <code>CachingControl</code> interface. It is posted when the caching
* state changes.
*
* @see Controller
* @see ControllerListener
* @see CachingControl
* @version 1.10, 97/08/23.
*/
public class CachingControlEvent extends ControllerEvent
{
CachingControl control;
long progress;
/**
* Construct a <CODE>CachingControlEvent</CODE> from the required elements.
*/
public CachingControlEvent(Controller from, CachingControl cacheControl,
long progress)
{ super(from); }
/**
* Get the <code>CachingControl</code> object that generated
* the event.
*
* @return The <code>CachingControl</code> object.
*/
public CachingControl getCachingControl() {
return null;
}
/**
* Get the total number of bytes of media data that have been downloaded so far.
*
* @return The number of bytes of media data downloaded.
*/
public long getContentProgress() {
return -1;
}
}
This diff is collapsed.
/**
<p>This is not an official specification document, and usage is restricted.
</p>
<a name="notice"><strong><center>
NOTICE
</center></strong><br>
<br>
(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
<p>
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.
<p>
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.
<p>
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
<p>
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.media;
/**
* <code>ClockStartedError</code> is thrown by a <i>Started</i>&nbsp;<code>Clock</code>
* when a method is invoked that is not legal on a <code>Clock</code> in the <i>Started</i>
* state. For example, this error is thrown if <code>syncStart</code> or
* <code>setTimeBase</code> is invoked on a <I>Started</I>&nbsp;<code>Clock</code>.
* <code>ClockStartedError</code> is also thrown if <code>addController</code> is
* invoked on a <I>Started</I>&nbsp;<code>Player</code>.
*
* @see Player
* @see Controller
* @see Clock
* @version 1.15, 97/08/23.
*/
public class ClockStartedError extends MediaError
{
/**
* Construct a <CODE>ClockStartedError</CODE> that contains the specified reason message.
*/
public ClockStartedError(String reason) { }
/**
* Construct a <CODE>ClockStartedError</CODE> with no message.
*/
public ClockStartedError() { }
}
/**
<p>This is not an official specification document, and usage is restricted.
</p>
<a name="notice"><strong><center>
NOTICE
</center></strong><br>
<br>
(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
<p>
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.
<p>
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.
<p>
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
<p>
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.media;
/**
* A <code>ClockStoppedException</code> is thrown when a method that
* expects the <I>Clock</I> to be <I>Started</I> is
* called on a <I>Stopped</I>&nbsp;<code>Clock</code>.
* For example, this exception is thrown if <code>mapToTimeBase</code>
* is called on a <I>Stopped</I>&nbsp;<code>Clock</code>.
*
* @version 1.12, 97/08/23
*/
public class ClockStoppedException extends MediaException
{
public ClockStoppedException() { }
public ClockStoppedException(String reason) { }
}
/**
<p>This is not an official specification document, and usage is restricted.
</p>
<a name="notice"><strong><center>
NOTICE
</center></strong><br>
<br>
(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
<p>
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.
<p>
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.
<p>
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
<p>
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.media;
import javax.media.Controller;
/**
* A <CODE>ConnectionErrorEvent</CODE> is posted when an error occurs within a <CODE>DataSource</CODE>
* when obtaining data or communicating with a server.
*
* @version 1.6, 97/08/23
*/
public class ConnectionErrorEvent extends ControllerErrorEvent
{
public ConnectionErrorEvent(Controller from) {
super(from);
}
public ConnectionErrorEvent(Controller from, String why) {
super(from);
}
}
/**
<p>This is not an official specification document, and usage is restricted.
</p>
<a name="notice"><strong><center>
NOTICE
</center></strong><br>
<br>
(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
<p>
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.
<p>
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.
<p>
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
<p>
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.media;
import java.awt.Component;
/**
* The base interface for processing <CODE>Control</CODE> objects.
*
* @version 1.13, 97/08/26
*/
public interface Control
{
/**
* Get the <code>Component</code> associated with this
* <code>Control</code> object.
* For example, this method might return
* a slider for volume control or a panel containing radio buttons for
* CODEC control.
* The <code>getControlComponent</code> method can return
* <CODE>null</CODE> if there is no GUI control for
* this <code>Control</code>.
*/
public Component getControlComponent();
}
This diff is collapsed.
/**
<p>This is not an official specification document, and usage is restricted.
</p>
<a name="notice"><strong><center>
NOTICE
</center></strong><br>
<br>
(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
<p>
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.
<p>
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.
<p>
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
<p>
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.media;
/**
* A <CODE>ControllerClosedEvent</CODE> describes an event that is
* generated when an a <code>Controller</code> is closed. This implies
* that the <code>Controller</code> is no longer operational.
*
* @see Controller
* @see ControllerListener
* @version 1.6, 97/08/23.
*/
public class ControllerClosedEvent extends ControllerEvent
{
protected String message;
/**
* Construct a <CODE>ControllerClosedEvent</CODE>.
*/
public ControllerClosedEvent(Controller from) {
super(from);
}
public ControllerClosedEvent(Controller from, String why) {
super(from);
}
/**
* Obtain the message describing why this event
* occurred.
*
* @return Message describing event cause.
*/
public String getMessage() {
return null;
}
}
/**
<p>This is not an official specification document, and usage is restricted.
</p>
<a name="notice"><strong><center>
NOTICE
</center></strong><br>
<br>
(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
<p>
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.