Class BeanInfoSupport
java.lang.Object
java.beans.SimpleBeanInfo
org.apache.jmeter.testbeans.BeanInfoSupport
- All Implemented Interfaces:
BeanInfo
- Direct Known Subclasses:
AccessLogSamplerBeanInfo, BeanShellBeanInfoSupport, CompareAssertionBeanInfo, ConstantThroughputTimerBeanInfo, CSVDataSetBeanInfo, DataSourceElementBeanInfo, DebugPostProcessorBeanInfo, DebugSamplerBeanInfo, Example2BeanInfo, Example3BeanInfo, JDBCTestElementBeanInfoSupport, KeystoreConfigBeanInfo, MongoScriptSamplerBeanInfo, MongoSourceElementBeanInfo, RandomVariableConfigBeanInfo, ScriptingBeanInfoSupport, SyncTimerBeanInfo
Support class for test bean beanInfo objects. It will help using the
introspector to get most of the information, to then modify it at will.
To use, subclass it, create a subclass with a parameter-less constructor that:
- Calls super(beanClass)
- Modifies the property descriptors, bean descriptor, etc. at will.
Even before any such modifications, a resource bundle named xxxResources (where xxx is the fully qualified bean class name) will be obtained if available and used to localize the following:
- Bean's display name -- from property displayName.
- Properties' display names -- from properties propertyName.displayName.
- Properties' short descriptions -- from properties propertyName.shortDescription.
The resource bundle will be stored as the bean descriptor's "resourceBundle" attribute, so that it can be used for further localization. TestBeanGUI, for example, uses it to obtain the group's display names from properties groupName.displayName.
- Version:
- $Revision: 1649775 $
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDefault value, must be provided ifNOT_UNDEFINEDis TRUEstatic final StringIf specified, create a multi-line editorstatic final StringWhether the field disallows JMeter expressions; Boolean, default FALSEstatic final StringWhether the field disallows constant values different from the provided tags; Boolean, default FALSEstatic final StringWhether the field must be defined (i.e. is required); Boolean, defaults to FALSEstatic final StringPointer to the resource bundle, if any (will generally be null)static final Stringstatic final StringTextEditor propertyFields inherited from interface BeanInfo
ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedBeanInfoSupport(Class<? extends TestBean> beanClass) Construct a BeanInfo for the given class. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcreatePropertyGroup(String group, String[] names) Utility method to group and order properties.BeanInfo[]intintgetIcon(int iconKind) protected PropertyDescriptorGet the property descriptor for the property of the given name.protected PropertyDescriptorGet the property descriptor for the property of the given name.protected PropertyDescriptorproperty(String name, TypeEditor editor) Get the property descriptor for the property of the given name.protected voidSet the bean's 16x16 colour icon.Methods inherited from class SimpleBeanInfo
loadImage
-
Field Details
-
TAGS
- See Also:
-
NOT_UNDEFINED
Whether the field must be defined (i.e. is required); Boolean, defaults to FALSE- See Also:
-
NOT_EXPRESSION
Whether the field disallows JMeter expressions; Boolean, default FALSE- See Also:
-
NOT_OTHER
Whether the field disallows constant values different from the provided tags; Boolean, default FALSE- See Also:
-
MULTILINE
-
DEFAULT
Default value, must be provided ifNOT_UNDEFINEDis TRUE- See Also:
-
RESOURCE_BUNDLE
Pointer to the resource bundle, if any (will generally be null)- See Also:
-
TEXT_LANGUAGE
-
-
Constructor Details
-
BeanInfoSupport
-
-
Method Details
-
property
Get the property descriptor for the property of the given name.- Parameters:
name- property name- Returns:
- descriptor for a property of that name, or null if there's none
-
property
Get the property descriptor for the property of the given name. Sets the GUITYPE to the provided editor.- Parameters:
name- property nameeditor- the TypeEditor enum that describes the property editor- Returns:
- descriptor for a property of that name, or null if there's none
-
property
Get the property descriptor for the property of the given name. Sets the GUITYPE to the provided enum.- Parameters:
name- property nameenumClass- the enum class that is to be used by the editor- Returns:
- descriptor for a property of that name, or null if there's none
-
setIcon
Set the bean's 16x16 colour icon.- Parameters:
resourceName- A pathname relative to the directory holding the class file of the current class.
-
createPropertyGroup
Utility method to group and order properties.It will assign the given group name to each of the named properties, and set their order attribute so that they are shown in the given order.
The created groups will get order 1, 2, 3,... in the order in which they are created.
- Parameters:
group- name of the groupnames- property names in the desired order
-
getAdditionalBeanInfo
- Specified by:
getAdditionalBeanInfoin interfaceBeanInfo- Overrides:
getAdditionalBeanInfoin classSimpleBeanInfo
-
getBeanDescriptor
- Specified by:
getBeanDescriptorin interfaceBeanInfo- Overrides:
getBeanDescriptorin classSimpleBeanInfo
-
getDefaultEventIndex
public int getDefaultEventIndex()- Specified by:
getDefaultEventIndexin interfaceBeanInfo- Overrides:
getDefaultEventIndexin classSimpleBeanInfo
-
getDefaultPropertyIndex
public int getDefaultPropertyIndex()- Specified by:
getDefaultPropertyIndexin interfaceBeanInfo- Overrides:
getDefaultPropertyIndexin classSimpleBeanInfo
-
getEventSetDescriptors
- Specified by:
getEventSetDescriptorsin interfaceBeanInfo- Overrides:
getEventSetDescriptorsin classSimpleBeanInfo
-
getIcon
- Specified by:
getIconin interfaceBeanInfo- Overrides:
getIconin classSimpleBeanInfo
-
getMethodDescriptors
- Specified by:
getMethodDescriptorsin interfaceBeanInfo- Overrides:
getMethodDescriptorsin classSimpleBeanInfo
-
getPropertyDescriptors
- Specified by:
getPropertyDescriptorsin interfaceBeanInfo- Overrides:
getPropertyDescriptorsin classSimpleBeanInfo
-