Package org.teiid.translator
Annotation Type TranslatorProperty
-
@Target(METHOD) @Retention(RUNTIME) @Inherited @Documented public @interface TranslatorProperty
Annotates a property that can be externally configured. The property name will be inferred from the method. Keep in mind that TranslatorProprties name are treated as case-insensitive - do not annotate two methods in the same ExecutionFactory with the same case-insensitive name.
-
-
Field Summary
Fields Modifier and Type Fields Description static String
EMPTY_STRING
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description boolean
advanced
True if this property should be shown in an advanced panel of properties.TranslatorProperty.PropertyType
category
Defines the type of the translator property.String
description
Description to be shown in toolsString
display
Display name to be shown in toolsboolean
masked
True if this is property should be masked when displayed - this has no effect on how the value is persisted.boolean
readOnly
True if the property has no setterboolean
required
True if a non-null value must be supplied
-
-
-
Field Detail
-
EMPTY_STRING
static final String EMPTY_STRING
-
-
Element Detail
-
description
String description
Description to be shown in tools- Returns:
- Default:
- ""
-
-
-
display
String display
Display name to be shown in tools- Returns:
- Default:
- ""
-
-
-
category
TranslatorProperty.PropertyType category
Defines the type of the translator property.- Returns:
- Default:
- org.teiid.translator.TranslatorProperty.PropertyType.OVERRIDE
-
-