Use is subject to License Terms. Your use of this web site or any of its content or software indicates your agreement to be bound by these License Terms.

Copyright © 2006 Sun Microsystems, Inc. All rights reserved.

javax.tv.xlet
Interface XletContext

public interface XletContext

An interface that provides methods allowing an Xlet to discover information about its environment. An XletContext is passed to an Xlet when the Xlet is initialized. It provides an Xlet with a mechanism to retrieve properties, as well as a way to signal internal state changes.

Critical resources (such as an Xlet's parent container and service context) can be obtained by means of an XletContext instance. Therefore, an Xlet's XletContext instance should only be accessible to other code that is highly trusted.

See Also:

Xlet, TVContainer, ServiceContextFactory.getServiceContext(javax.tv.xlet.XletContext)

Field Summary

static java.lang.String

ARGS The property key used to obtain initialization arguments for the Xlet.

Method Summary

java.lang.Object	getXletProperty(java.lang.String key) Provides an Xlet with a mechanism to retrieve named properties from the XletContext.
void	notifyDestroyed() Used by an application to notify its manager that it has entered into the Destroyed state.
void	notifyPaused() Notifies the manager that the Xlet does not want to be active and has entered the Paused state.
void	resumeRequest() Provides the Xlet with a mechanism to indicate that it is interested in entering the Active state.

Field Detail

ARGS

public static final java.lang.String ARGS

The property key used to obtain initialization arguments for the Xlet. The call XletContext.getXletProperty(XletContext.ARGS) will return the arguments as an array of Strings. If there are no arguments, then an array of length 0 will be returned.

See Also:

getXletProperty(java.lang.String), Constant Field Values

Method Detail

notifyDestroyed

public void notifyDestroyed()

Used by an application to notify its manager that it has entered into the Destroyed state. The application manager will not call the Xlet's destroy method, and all resources held by the Xlet are considered eligible for immediate reclamation. Before calling this method, the Xlet must perform the same operations (clean up, releasing of resources etc.) as it would in response to call to Xlet.destroyXlet(boolean).

If this method is called during the execution of one of the Xlet state transition methods, the Xlet will immediately transition into the Destroyed state and the Xlet state transition method is considered to have completed unsuccesfully.

notifyPaused

public void notifyPaused()

Notifies the manager that the Xlet does not want to be active and has entered the Paused state. Invoking this method will have no effect if the Xlet is destroyed, or if it has not yet been started.

If an Xlet calls notifyPaused(), in the future it may receive an Xlet.startXlet() call to request it to become active, or an Xlet.destroyXlet() call to request it to destroy itself.

getXletProperty

public java.lang.Object getXletProperty(java.lang.String key)

Provides an Xlet with a mechanism to retrieve named properties from the XletContext.

Parameters:

key - The name of the property.

Returns:

A reference to an object representing the property. null is returned if no value is available for key.

resumeRequest

public void resumeRequest()

Provides the Xlet with a mechanism to indicate that it is interested in entering the Active state. Calls to this method can be used by an application manager to determine which Xlets to move to Active state. Any subsequent call to Xlet.startXlet() as a result of this method will be made via a different thread than the one used to call resumeRequest().

See Also:

Xlet.startXlet()