Enum SearchExpressionHint
- java.lang.Object
-
- java.lang.Enum<SearchExpressionHint>
-
- jakarta.faces.component.search.SearchExpressionHint
-
- All Implemented Interfaces:
Serializable
,Comparable<SearchExpressionHint>
public enum SearchExpressionHint extends Enum<SearchExpressionHint>
An enum that specifies hints that impact the behavior of a component tree search.
- Since:
- 2.3
-
-
Enum Constant Summary
Enum Constants Enum Constant Description IGNORE_NO_RESULT
Hint that indicates that if a expression resolves tonull
,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 realUIComponent
s should be resolved.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static SearchExpressionHint
valueOf(String name)
Returns the enum constant of this type with the specified name.static SearchExpressionHint[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 aComponentNotFoundException
will be thrown.- Since:
- 2.3
-
SKIP_VIRTUAL_COMPONENTS
public static final SearchExpressionHint SKIP_VIRTUAL_COMPONENTS
Hint that indicates that only real
UIComponent
s should be resolved. Virtual components are components, which are reused in repeatable components likeUIData
orui: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
usesUIComponent.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 ifSearchExpressionHandler.resolveClientId(jakarta.faces.component.search.SearchExpressionContext, java.lang.String)
orSearchExpressionHandler.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.
-
-
Method Detail
-
values
public static SearchExpressionHint[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (SearchExpressionHint c : SearchExpressionHint.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SearchExpressionHint valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
-