- java.lang.Object
-
- org.praxislive.core.protocols.ComponentProtocol
-
-
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 ComponentInfo
API_INFO
A component info for this protocol.static String
INFO
Name of the info control.static ControlInfo
INFO_INFO
Control info for the info control.static ComponentProtocol
INSTANCE
Deprecated.
-
Constructor Summary
Constructors Constructor Description ComponentProtocol()
-
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
-
INSTANCE
@Deprecated public static final ComponentProtocol INSTANCE
Deprecated.
-
INFO
public static final String INFO
Name of the info control.- See Also:
- Constant Field Values
-
INFO_INFO
public static final ControlInfo INFO_INFO
Control info for the info control. A read-only property that returns the component info. The response to calling this control should be the same as callingComponent.getInfo()
.
-
API_INFO
public static final ComponentInfo API_INFO
A component info for this protocol. Can be used withInfo.ComponentInfoBuilder.merge(org.praxislive.core.ComponentInfo)
.
-
-
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.
-
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 interfaceProtocol
- Parameters:
control
- name of control- Returns:
- control info for named control
-
-