Package com.carfey.ops.job.param

Class StaticListProvider

java.lang.Object

com.carfey.ops.job.param.StaticListProvider

All Implemented Interfaces:

ListProvider

public class StaticListProvider
extends java.lang.Object
implements ListProvider

ListProvider implementation which allows for configuration of a static list of values.

Since:

3.3

Nested Class Summary

Nested classes/interfaces inherited from interface com.carfey.ops.job.param.ListProvider

ListProvider.DynamicListProvider

Constructor Summary

Constructors

Constructor	Description
StaticListProvider()

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getValidValues(java.util.List<java.lang.String> arguments, boolean beforeExecute)	Return a list of valid values for this parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticListProvider

public StaticListProvider()

Method Detail

getValidValues

public java.util.List<java.lang.String> getValidValues(java.util.List<java.lang.String> arguments,
                                                       boolean beforeExecute)

Description copied from interface: ListProvider

Return a list of valid values for this parameter.

Specified by:

getValidValues in interface ListProvider

Parameters:

arguments - values supplied in Parameter.listArgs() (never null)

beforeExecute - indicates if this check is happening right before the job is being executed. This allows implementations to only validate valid values at configuration time by returning null when beforeExecute is true. If you wish to enforce values at all times, simply ignore this flag.

Returns:

a list of all valid values (includes empty lists), or null, which means any value may be configured