org.josef.web.jsf.util

Class JsfSelectItemUtil

java.lang.Object

org.josef.web.jsf.util.JsfSelectItemUtil

public final class JsfSelectItemUtil
extends Object

Java Server Faces Utility class for SelectItems..

Version:

1.0 $Revision: 5782 $

Author:

Kees Schotanus

Field Summary

Fields

Modifier and Type	Field and Description
static javax.faces.model.SelectItem[]	EMPTY_ARRAY_OF_SELECT_ITEMS Empty array of SelectItems.

Method Summary

Modifier and Type	Method and Description
static String	getLabelFromSelectItemsAndValue(javax.faces.model.SelectItem[] selectItems, Object value) Gets the label of the SelectItem with the supplied value from the supplied selectItems.
static String	getLabelsFromSelectItemsAndValues(javax.faces.model.SelectItem[] selectItems, Object values) Gets the labels of the supplied selectItems, corresponding to the supplied values, as a comma separated list.
static List<javax.faces.model.SelectItem>	getSelectItems(javax.faces.component.UIInput uiInput) Gets all the SelectItems from the supplied uiComponent.
static boolean	hasZeroOrOneSelectItem(javax.faces.component.UIInput uiInput) Determines whether the supplied uiComponent contains zero or one SelectItem.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY_OF_SELECT_ITEMS

public static final javax.faces.model.SelectItem[] EMPTY_ARRAY_OF_SELECT_ITEMS

Empty array of SelectItems.

Method Detail

hasZeroOrOneSelectItem

public static boolean hasZeroOrOneSelectItem(javax.faces.component.UIInput uiInput)

Determines whether the supplied uiComponent contains zero or one SelectItem.

Parameters:

uiInput - The component to check.

Returns:

True when the supplied uiComponent contains zero or one SelectItem, otherwise false is returned.

getSelectItems

public static List<javax.faces.model.SelectItem> getSelectItems(javax.faces.component.UIInput uiInput)

Gets all the SelectItems from the supplied uiComponent.
A Select component can contain nested <f:selectItem> and nested <selectItems>. There are represented by respectively UISelectItem and UISelectItems.

Parameters:

uiInput - The component to get the SelectItems from.

Returns:

All SelectItems from the supplied uiComponent.
The returned List may be empty but will never be null.

Throws:

IllegalStateException - When the SelectItems are not backed by a single SelectItem, Collection, Array or Map.

getLabelFromSelectItemsAndValue

public static String getLabelFromSelectItemsAndValue(javax.faces.model.SelectItem[] selectItems,
                                                     Object value)

Gets the label of the SelectItem with the supplied value from the supplied selectItems.

Parameters:

selectItems - The select items to get a single label from.

value - The value of the select item.

Returns:

the Label of the SelectItem with the supplied value from the supplied selectItems.

Throws:

IllegalArgumentException - When the supplied selectItems is empty or when the supplied selectItems does not contain a SelectItem with the supplied value.

NullPointerException - When the supplied selectItems is null.

getLabelsFromSelectItemsAndValues

public static String getLabelsFromSelectItemsAndValues(javax.faces.model.SelectItem[] selectItems,
                                                       Object values)

Gets the labels of the supplied selectItems, corresponding to the supplied values, as a comma separated list.

Parameters:

selectItems - The select items to get the labels from.

values - The selected values.
This can currently either be an Array or a List.

Returns:

A comma separated list of labels, corresponding to the supplied values of the supplied selectItems.

Throws:

IllegalArgumentException - When the supplied selectItems is empty.

NullPointerException - When the supplied selectItems or values are null.