Package de.sfuhrm.radiobrowser4j

Class ListParameter

java.lang.Object

de.sfuhrm.radiobrowser4j.Parameter

de.sfuhrm.radiobrowser4j.ListParameter

public final class ListParameter
extends Parameter

Parameters for list calls.

Author:

Stephan Fuhrmann

Method Summary

Modifier and Type	Method	Description
protected void	apply(Map<String,String> requestParams)	Transfer this list parameter to the passed multi-valued-map.
static ListParameter	create()	Creates a new instance.
ListParameter	order(@NonNull FieldName fieldName)	Order by the given field name.
ListParameter	reverseOrder(boolean reverse)	Switch to reverse order.

Methods inherited from class java.lang.Object

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

Method Details

create

public static ListParameter create()

Creates a new instance.

Returns:

a new instance.

order

public ListParameter order(@NonNull
 @NonNull FieldName fieldName)

Order by the given field name.

Parameters:

fieldName - the field name to order by.

Returns:

this instance.

reverseOrder

public ListParameter reverseOrder(boolean reverse)

Switch to reverse order.

Parameters:

reverse - whether to order reverse.

Returns:

this instance.

apply

protected void apply(Map<String,String> requestParams)

Transfer this list parameter to the passed multi-valued-map.

Parameters:

requestParams - the target of the list params.