Annotation Interface DataMethodQueryParameter
@Retention(RUNTIME)
@Target({METHOD,ANNOTATION_TYPE})
@Internal
@Inherited
public @interface DataMethodQueryParameter
Internal annotation representing query parameter binding.
- Since:
- 3.2
- Author:
- Denis Stepanov
-
Optional Element Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The member name that holds the auto-populated value.static final String
The member name that holds the converter class.static final String
The member name that holds the data type.static final String
The member name that holds expandable.static final String
The member name that holds the JSON data type.static final String
The member name that holds an optional query parameter name.static final String
The member name that holds the parameter binding path.static final String
The member name that holds the parameter index.static final String
The member name that holds the property name.static final String
The member name that holds the property path.static final String
The member name that holds requiresPreviousPopulatedValue.
-
Field Details
-
META_MEMBER_NAME
The member name that holds an optional query parameter name.- See Also:
-
META_MEMBER_DATA_TYPE
The member name that holds the data type.- See Also:
-
META_MEMBER_JSON_DATA_TYPE
The member name that holds the JSON data type.- See Also:
-
META_MEMBER_PARAMETER_INDEX
The member name that holds the parameter index.- See Also:
-
META_MEMBER_PARAMETER_BINDING_PATH
The member name that holds the parameter binding path.- See Also:
-
META_MEMBER_PROPERTY
The member name that holds the property name.- See Also:
-
META_MEMBER_PROPERTY_PATH
The member name that holds the property path.- See Also:
-
META_MEMBER_CONVERTER
The member name that holds the converter class.- See Also:
-
META_MEMBER_AUTO_POPULATED
The member name that holds the auto-populated value.- See Also:
-
META_MEMBER_REQUIRES_PREVIOUS_POPULATED_VALUES
The member name that holds requiresPreviousPopulatedValue.- See Also:
-
META_MEMBER_EXPANDABLE
The member name that holds expandable.- See Also:
-
-
Element Details
-
name
String name- Returns:
- The query parameter name
- Default:
- ""
-
dataType
DataType dataType- Returns:
- The data type.
- Default:
- OBJECT
-
parameterIndex
int parameterIndex- Returns:
- The parameter index
- Default:
- -1
-
parameterBindingPath
String[] parameterBindingPath- Returns:
- The parameter binding property path
- Default:
- {}
-
property
String propertyThe property name that this parameter is representing. If property is from an association or an embedded entity the value would be empty and `propertyPath` would be set instead.- Returns:
- The property name.
- Default:
- ""
-
propertyPath
String[] propertyPathThe path to the property that this parameter is representing. Only set if the property is from an association or from an embedded entity.- Returns:
- The property path.
- Default:
- {}
-
converter
Class[] converter- Returns:
- The property converter class
- Default:
- {}
-
autoPopulated
boolean autoPopulated- Returns:
- true if property is auto-populated
- Default:
- false
-
requiresPreviousPopulatedValue
boolean requiresPreviousPopulatedValue- Returns:
- true if the value has to be previous populated value and not a newly generated.
- Default:
- false
-