org.josef.web.jsf.util

Class JsfAutoCompleteUtil

java.lang.Object

org.josef.web.jsf.util.JsfAutoCompleteUtil

public final class JsfAutoCompleteUtil
extends Object

Java Server Faces Utility class that aids in auto completing information.

Version:

1.0 $Revision: 3786 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static List<javax.faces.model.SelectItem>	getAutoCompleteSuggestions(List<javax.faces.model.SelectItem> allSuggestions, String autoCompleteText, int maxNumberOfSuggestions) Gets auto complete suggestions.

Methods inherited from class java.lang.Object

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

Method Detail

getAutoCompleteSuggestions

public static List<javax.faces.model.SelectItem> getAutoCompleteSuggestions(List<javax.faces.model.SelectItem> allSuggestions,
                                                                            String autoCompleteText,
                                                                            int maxNumberOfSuggestions)

Gets auto complete suggestions.

Parameters:

allSuggestions - The complete list of possible suggestions.
This list must previously have been sorted or the results will be indeterminate.

autoCompleteText - The text already entered by the user.

maxNumberOfSuggestions - The maximum number of suggestions that will be returned.

Returns:

A list of suggestions from the supplied allSuggestions that match the supplied autoCompleteText.

Throws:

NullPointerException - When either the supplied list of suggestions or the supplied autoCompleteText is null.

IllegalArgumentException - When the supplied maxNumberOfSuggestions is less than 1. null.