Package io.deephaven.enterprise.controller.assignment

Class AssignmentPolicyConfig

java.lang.Object

io.deephaven.enterprise.controller.assignment.AssignmentPolicyConfig

public class AssignmentPolicyConfig
extends Object

This class contains the configuration for a single Assignment Policy

Constructor Summary

Constructors

Constructor	Description
AssignmentPolicyConfig(String name, String displayName, String implementationClass, String description, boolean acceptsParameters)

Method Summary

Modifier and Type	Method	Description
boolean	acceptsParameters()	Get if this policy accepts configuration parameters during construction.
String	getDescription()	Get the optional description of this policy.
String	getDisplayName()	Get the name to display to users.
String	getImplementationClass()	Get the fully qualified implementation class.
String	getName()	Get the name of the policy for use by the Controller

Methods inherited from class java.lang.Object

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

Constructor Details

AssignmentPolicyConfig

public AssignmentPolicyConfig(@NotNull
 String name,
 @NotNull
 String displayName,
 @Nullable
 String implementationClass,
 @Nullable
 String description,
 boolean acceptsParameters)

Method Details

getName

@NotNull
public String getName()

Get the name of the policy for use by the Controller

Returns:

the name of the policy

getDisplayName

@NotNull
public String getDisplayName()

Get the name to display to users.

Returns:

the display name

getImplementationClass

@Nullable
public String getImplementationClass()

Get the fully qualified implementation class. This can be null for clients.

Returns:

the fully qualified implementation class

getDescription

@Nullable
public String getDescription()

Get the optional description of this policy. May be null if there is no description.

Returns:

the description or null if there is none

acceptsParameters

public boolean acceptsParameters()

Get if this policy accepts configuration parameters during construction.

Returns:

true if it accepts parameters