javax.media.CachingControlEvent 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!

/*
 * @(#)CachingControlEvent.java	1.12 98/03/28
 *
 * Copyright 1996-1998 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.media;

/**
 * This event is generated by a Controller that supports
 * the CachingControl interface.  It is posted when the caching 
 * state changes.
 *
 * @see Controller
 * @see ControllerListener
 * @see CachingControl
 * @version 1.12, 98/03/28.
 */
public class CachingControlEvent extends ControllerEvent {

    CachingControl control;
    long progress;
    
    /**
     * Construct a CachingControlEvent from the required elements.
     */
    public CachingControlEvent(Controller from, CachingControl cacheControl,
			       long progress) {
	super(from);
	control = cacheControl;
	this.progress = progress;
    }

    /**
     * Get the CachingControl object that generated
     * the event.
     *
     * @return The CachingControl object.
     */

    public CachingControl getCachingControl() {
	return control;
    }
    
    /**
     * 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 progress;
    }

    /**
     * Returns the String representation of this event's values.
     */
    public String toString() {
	return getClass().getName() + "[source=" + eventSrc + 
	    ",cachingControl=" + control + 
	    ",progress=" + progress + "]";
    }
}