sila_java.library.server_base.standard_features.v1

Class ParameterConstraintsProvider

java.lang.Object

sila_java.library.server_base.standard_features.v1.ParameterConstraintsProvider

All Implemented Interfaces:

AutoCloseable, FeatureImplementation

public class ParameterConstraintsProvider
extends Object
implements FeatureImplementation, AutoCloseable

Parameter constraints provider core feature implementation

Field Summary

Fields

Modifier and Type	Field and Description
static String	FULLY_QUALIFIED_FEATURE_IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
ParameterConstraintsProvider()

Method Summary

Modifier and Type	Method and Description
void	close() complete observers stream and clear constraintUpdateObservers
String	getFeatureDescription() Gets Feature Description in XML Form as String
Map<String,Constraints>	getParametersConstraints() Get parameters constraints
BindableService	getService() Gets gRPC Service to serve
void	putConstraint(@NonNull String parameterId, @NonNull Constraints constraints) Insert a constraint to a parameter
void	removeConstraint(@NonNull String parameterId) Remove a parameter constraint

Methods inherited from class java.lang.Object

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

Field Detail

FULLY_QUALIFIED_FEATURE_IDENTIFIER

public static final String FULLY_QUALIFIED_FEATURE_IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

ParameterConstraintsProvider

public ParameterConstraintsProvider()

Method Detail

getFeatureDescription

public String getFeatureDescription()

Description copied from interface: FeatureImplementation

Gets Feature Description in XML Form as String

Specified by:

getFeatureDescription in interface FeatureImplementation

Returns:

XML String

getService

public BindableService getService()

Description copied from interface: FeatureImplementation

Gets gRPC Service to serve

Specified by:

getService in interface FeatureImplementation

Returns:

bindable service

close

public void close()

complete observers stream and clear constraintUpdateObservers

Specified by:

close in interface AutoCloseable

getParametersConstraints

public Map<String,Constraints> getParametersConstraints()

Get parameters constraints

Returns:

an unmodifiable map of constraints

putConstraint

public void putConstraint(@NonNull
                          @NonNull String parameterId,
                          @NonNull
                          @NonNull Constraints constraints)

Insert a constraint to a parameter

Parameters:

parameterId - the parameter identifier

constraints - the constraints

removeConstraint

public void removeConstraint(@NonNull
                             @NonNull String parameterId)

Remove a parameter constraint

Parameters:

parameterId - the parameter identifier