Package net.solarnetwork.service

Class StaticOptionalService<T>

java.lang.Object

net.solarnetwork.service.StaticOptionalService<T>

Type Parameters:

T - the service type

All Implemented Interfaces:

FilterableService, OptionalService<T>, OptionalService.OptionalFilterableService<T>

public class StaticOptionalService<T>
extends Object
implements OptionalService.OptionalFilterableService<T>

Implementation of OptionalService.OptionalFilterableService using a static service instance.

This can be useful when the OptionalService.OptionalFilterableService API is required, but the service is known and available statically.

Version:

1.2

Author:

matt

Nested Class Summary

Nested classes/interfaces inherited from interface net.solarnetwork.service.OptionalService

OptionalService.OptionalFilterableService<T>

Constructor Summary

Constructors

Constructor	Description
StaticOptionalService(T service)	Constructor.

Method Summary

Modifier and Type	Method	Description
Map<String,?>	getPropertyFilters()	Get the current map of property filters, with keys representing property names and value their desired associated value.
Object	removePropertyFilter(String key)	Remove a property filter value.
T	service()	Get the configured service, or null if none available.
void	setPropertyFilter(String key, Object value)	Set a property filter value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.solarnetwork.service.FilterableService

getPropertyValue

Constructor Details

StaticOptionalService

public StaticOptionalService(T service)

Constructor.

Parameters:

service - the static service to use

Method Details

service

public T service()

Description copied from interface: OptionalService

Get the configured service, or null if none available.

Specified by:

service in interface OptionalService<T>

Returns:

the service, or null

getPropertyFilters

public Map<String,?> getPropertyFilters()

Description copied from interface: FilterableService

Get the current map of property filters, with keys representing property names and value their desired associated value.

Specified by:

getPropertyFilters in interface FilterableService

Returns:

filters

setPropertyFilter

public void setPropertyFilter(String key,
 Object value)

Description copied from interface: FilterableService

Set a property filter value.

Specified by:

setPropertyFilter in interface FilterableService

Parameters:

key - the key to add

value - the value

removePropertyFilter

public Object removePropertyFilter(String key)

Description copied from interface: FilterableService

Remove a property filter value.

Specified by:

removePropertyFilter in interface FilterableService

Parameters:

key - the key to remove

Returns:

the removed value, or null if no value was available