Package org.opencastproject.list.common.provider

Class BooleanListProvider

java.lang.Object

org.opencastproject.list.common.provider.BooleanListProvider

All Implemented Interfaces:

ResourceListProvider

public class BooleanListProvider
extends Object
implements ResourceListProvider

Boolean list provider.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NO
static final String	YES
static final String	YES_NO

Constructor Summary

Constructors

Constructor	Description
BooleanListProvider()

Method Summary

Modifier and Type	Method	Description
String	getDefault()	Returns the key of the default value in the list if customized, else null.
Map<String,String>	getList(String listName, ResourceListQuery query)	Returns the key-value list for the generator resource filtered with the given filter and based on the given organization context.
String[]	getListNames()	Returns the names of the list(s) provided
boolean	isTranslatable(String listName)	Defines if keys and values of the given list should be translated in the administrative user interface.
static <Boolean> Optional<Boolean>	parseValue(String filterValue)	Parse boolean value from the given string.

Methods inherited from class java.lang.Object

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

Field Details

YES_NO

public static final String YES_NO

See Also:

• Constant Field Values

YES

public static final String YES

See Also:

• Constant Field Values

NO

public static final String NO

See Also:

• Constant Field Values

Constructor Details

BooleanListProvider

public BooleanListProvider()

Method Details

getListNames

public String[] getListNames()

Description copied from interface: ResourceListProvider

Returns the names of the list(s) provided

Specified by:

getListNames in interface ResourceListProvider

Returns:

an array containing the lists available

getList

public Map<String,String> getList(String listName,
 ResourceListQuery query)

Description copied from interface: ResourceListProvider

Returns the key-value list for the generator resource filtered with the given filter and based on the given organization context.

Specified by:

getList in interface ResourceListProvider

Parameters:

listName - the list name

query - the list query

Returns:

the key-value list for the generator resource

parseValue

public static <Boolean> Optional<Boolean> parseValue(String filterValue)

Parse boolean value from the given string.

Parameters:

filterValue - boolean value as string

Returns:

boolean value wrapped in an Optional or Optional.empty()

isTranslatable

public boolean isTranslatable(String listName)

Description copied from interface: ResourceListProvider

Defines if keys and values of the given list should be translated in the administrative user interface.

Specified by:

isTranslatable in interface ResourceListProvider

Parameters:

listName - the name of the list

Returns:

if the results should be translated

getDefault

public String getDefault()

Description copied from interface: ResourceListProvider

Returns the key of the default value in the list if customized, else null.

Specified by:

getDefault in interface ResourceListProvider

Returns:

key of default value or null