javax.media.protocol.Controls 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.media.protocol;

/** 
 * 
 * Controls provides an interface for
 * obtaining objects by interface or class name.
 * This is useful in the case where support for a particular
 * interface cannot be determined at runtime, or where a
 * different object is required to implement the behavior.
 * The object returned from getControl
 * is assumed to control the object that
 * getControl was invoked on.
 *
 * @version 1.4, 97/08/28.
 */
public interface Controls
{

    /** 
     * Obtain the collection of objects that
     * control the object that implements this interface.
     * 

     *
     * If no controls are supported, a zero length
     * array is returned.
     *
     * @return the collection of object controls
     */
    public Object[] getControls();

    /** 
     * Obtain the object that implements the specified
     * Class or Interface
     * The full class or interface name must be used.
     * 
     * 
     * If the control is not supported then null
     * is returned.
     *
     * @return the object that implements the control,
     * or null.
     */
    public Object getControl(String controlType);
}