Module org.praxislive.code

Package org.praxislive.code

Class CodeRootFactoryService

java.lang.Object

org.praxislive.code.CodeRootFactoryService

All Implemented Interfaces:

Protocol, Service

public final class CodeRootFactoryService
extends Object
implements Service

A factory service for code root components. Provides the same API as RootFactoryService for use as a redirect with ComponentFactory.rootRedirect().

Nested Class Summary

Nested classes/interfaces inherited from interface org.praxislive.core.Protocol

Protocol.Type<T extends Protocol>, Protocol.TypeProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NEW_ROOT_INSTANCE	Control ID of the new root instance control.
static final ControlInfo	NEW_ROOT_INSTANCE_INFO	ControlInfo of the new root instance control.

Constructor Summary

Constructors

Constructor	Description
CodeRootFactoryService()

Method Summary

Modifier and Type	Method	Description
Stream<String>	controls()	The names of the controls that a component advertising this protocol must provide.
ControlInfo	getControlInfo(String control)	Query the ControlInfo for the provided control name on this protocol.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.praxislive.core.Protocol

optionalControls

Field Details

NEW_ROOT_INSTANCE

public static final String NEW_ROOT_INSTANCE

Control ID of the new root instance control.

See Also:

• Constant Field Values

NEW_ROOT_INSTANCE_INFO

public static final ControlInfo NEW_ROOT_INSTANCE_INFO

ControlInfo of the new root instance control.

Constructor Details

CodeRootFactoryService

public CodeRootFactoryService()

Method Details

controls

public Stream<String> controls()

Description copied from interface: Protocol

The names of the controls that a component advertising this protocol must provide.

Specified by:

controls in interface Protocol

Returns:

stream of control names

getControlInfo

public ControlInfo getControlInfo(String control)

Description copied from interface: Protocol

Query the ControlInfo for the provided control name on this protocol. The component implementing this protocol will generally use the control info provided here inside its component info. In exceptional circumstances, the component may extend or adapt the behaviour of the control, as long as it is fully compatible with this control info and the specification.

Specified by:

getControlInfo in interface Protocol

Parameters:

control - name of control

Returns:

control info for named control