Module jakarta.faces

Package jakarta.faces.component.search

Enum Class SearchExpressionHint

java.lang.Object

java.lang.Enum<SearchExpressionHint>

jakarta.faces.component.search.SearchExpressionHint

All Implemented Interfaces:

Serializable, Comparable<SearchExpressionHint>, Constable

public enum SearchExpressionHint
extends Enum<SearchExpressionHint>

An enum that specifies hints that impact the behavior of a component tree search.

Since:

2.3

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IGNORE_NO_RESULT	Hint that indicates that if a expression resolves to null, null will be returned.
RESOLVE_CLIENT_SIDE	Hint that indicates that a keyword can be resolved later and will just be returned as passthrough, if supported by the keyword.
RESOLVE_SINGLE_COMPONENT	Hint that indicates that only one component should be resolved.
SKIP_VIRTUAL_COMPONENTS	Hint that indicates that only real UIComponents should be resolved.

Method Summary

Modifier and Type	Method	Description
static SearchExpressionHint	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchExpressionHint[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IGNORE_NO_RESULT

public static final SearchExpressionHint IGNORE_NO_RESULT

Hint that indicates that if a expression resolves to null, null will be returned. Otherwise a ComponentNotFoundException will be thrown.

Since:

2.3

SKIP_VIRTUAL_COMPONENTS

public static final SearchExpressionHint SKIP_VIRTUAL_COMPONENTS

Hint that indicates that only real UIComponents should be resolved. Virtual components are components, which are reused in repeatable components like UIData or ui:repeat.

Since:

2.3

RESOLVE_SINGLE_COMPONENT

public static final SearchExpressionHint RESOLVE_SINGLE_COMPONENT

Hint that indicates that only one component should be resolved. This hint is important if a SearchKeywordResolver uses UIComponent.visitTree(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.visit.VisitCallback), as the tree visit can be terminated after the first component was resolved. This hint will be automatically added internally if SearchExpressionHandler.resolveClientId(jakarta.faces.component.search.SearchExpressionContext, java.lang.String) or SearchExpressionHandler.resolveComponent(jakarta.faces.component.search.SearchExpressionContext, java.lang.String, jakarta.faces.component.ContextCallback) is used.

Since:

2.3

RESOLVE_CLIENT_SIDE

public static final SearchExpressionHint RESOLVE_CLIENT_SIDE

Hint that indicates that a keyword can be resolved later and will just be returned as passthrough, if supported by the keyword. For example: The AJAX client- and server-side is able to handle @all or @form. So it's not necessary at all to resolve them to their clientId's on the server side.

Since:

2.3

See Also:

• SearchKeywordResolver.isPassthrough(jakarta.faces.component.search.SearchExpressionContext, java.lang.String)

Method Details

values

public static SearchExpressionHint[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SearchExpressionHint valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null