public interface Parameters
String-keyed parameter map. The parameter mappings are defined
by a synthetic component builder. The CDI container passes the parameter map
to functions defined by the same synthetic component builder, whenever
it needs to invoke those functions. That is:
SyntheticBeanBuilder;SyntheticObserverBuilder.Parameters-accepting
function without a change. For example, if the builder defines an int parameter,
it must be looked up as int and cannot be looked up as long.
Values of primitive types may be looked up either using the primitive type (such as
int.class), or using the corresponding wrapper type (Integer.class).
The return value is always of the wrapper type, so that null can be returned
when the parameter does not exist. Note that this does not apply to arrays
of primitive types; an int[] cannot be looked up as Integer[].
This is because arrays are reference types and so null can be returned.
Class-typed parameters are available as instances of Class, even if an instance
of ClassInfo was passed to the builder.
Annotation-typed parameters are available as instances of the annotation type,
even if an instance of AnnotationInfo was passed to the builder.
| Modifier and Type | Method and Description |
|---|---|
<T> T |
get(java.lang.String key,
java.lang.Class<T> type)
Returns the value of a parameter with given
key. |
<T> T |
get(java.lang.String key,
java.lang.Class<T> type,
T defaultValue)
Returns the value of a parameter with given
key. |
<T> T get(java.lang.String key,
java.lang.Class<T> type)
key. The value is expected to be of given type.T - the parameter typekey - the parameter key; must not be nulltype - the parameter type; must not be nullnull if parameter with given key does not existjava.lang.ClassCastException - if the parameter exists, but is of a different type<T> T get(java.lang.String key,
java.lang.Class<T> type,
T defaultValue)
key. The value is expected to be of given type.
If the parameter does not exist, returns defaultValue.T - the parameter typekey - the parameter key; must not be nulltype - the parameter type; must not be nulldefaultValue - the value to return if parameter with given key does not existdefaultValue if parameter with given key does not existjava.lang.ClassCastException - if the parameter exists, but is of a different type