ScriptService (PraxisCORE 5.7.0 API)

java.lang.Object
- org.praxislive.core.services.ScriptService

All Implemented Interfaces:: Protocol, Service

public class ScriptService
extends Object
implements Service

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 String CLEAR

static ControlInfo CLEAR_INFO

static String EVAL

static ControlInfo EVAL_INFO

Constructor Summary

Constructors
Constructor Description

ScriptService()

Method Summary

All Methods Instance Methods Concrete Methods
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 Detail
  - EVAL
```
public static final String EVAL
```
    See Also:
    
    Constant Field Values
  - CLEAR
```
public static final String CLEAR
```
    See Also:
    
    Constant Field Values
  - EVAL_INFO
```
public static final ControlInfo EVAL_INFO
```
  - CLEAR_INFO
```
public static final ControlInfo CLEAR_INFO
```
- Constructor Detail
  - ScriptService
```
public ScriptService()
```
- Method Detail
  - 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