abbot.script

Class PropertyCall

java.lang.Object

abbot.script.Step

abbot.script.Call

abbot.script.PropertyCall

All Implemented Interfaces:

XMLConstants, XMLifiable, java.io.Serializable

Direct Known Subclasses:

Assert, Sample

public abstract class PropertyCall
extends Call

Provides support for using property-like methods, including select non-static method access to Components. Specifically, allows specification of a ComponentReference to be used as the method invocation target. If a ComponentReference is given, then the class of the component reference is used as the target class.

See Also:

Serialized Form

Field Summary

Fields inherited from interface abbot.script.XMLConstants

TAG_ACTION, TAG_APPLETVIEWER, TAG_ARCHIVE, TAG_ARGS, TAG_ASSERT, TAG_AWT, TAG_AWTTESTSCRIPT, TAG_BORDER_TITLE, TAG_CALL, TAG_CLASS, TAG_CLASSPATH, TAG_CODE, TAG_CODEBASE, TAG_COMMENT, TAG_COMPONENT, TAG_COUNT, TAG_DELEGATE, TAG_DESC, TAG_DOCBASE, TAG_EVENT, TAG_EXPR, TAG_FILENAME, TAG_FIXTURE, TAG_FORKED, TAG_HEIGHT, TAG_HORDER, TAG_ICON, TAG_ID, TAG_INDEX, TAG_INVERT, TAG_INVOKER, TAG_KEYCHAR, TAG_KEYCODE, TAG_KIND, TAG_LABEL, TAG_LAUNCH, TAG_METHOD, TAG_MODIFIERS, TAG_NAME, TAG_PARAMS, TAG_PARENT, TAG_POLL_INTERVAL, TAG_PROPERTY, TAG_ROOT, TAG_SAMPLE, TAG_SCRIPT, TAG_SEQUENCE, TAG_SLOW, TAG_STOP_ON_ERROR, TAG_STOP_ON_FAILURE, TAG_TAG, TAG_TERMINATE, TAG_TEXT, TAG_THREADED, TAG_TIMEOUT, TAG_TITLE, TAG_TRIGGER, TAG_TYPE, TAG_VALUE, TAG_VMARGS, TAG_VORDER, TAG_WAIT, TAG_WEIGHTED, TAG_WIDTH, TAG_WINDOW, TAG_X, TAG_Y

Constructor Summary

Constructors

Constructor and Description
PropertyCall(Resolver resolver, java.util.Map attributes) Create a PropertyCall based on loaded XML attributes.
PropertyCall(Resolver resolver, java.lang.String description, java.lang.String methodName, java.lang.String id) Create a PropertyCall with a Component target.
PropertyCall(Resolver resolver, java.lang.String description, java.lang.String className, java.lang.String methodName, java.lang.String[] args) Create a PropertyCall based on a static invocation on an arbitrary class.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map	getAttributes() Save attributes specific to this Step class.
java.lang.String	getComponentID() Return the component reference ID used by this method invocation.
java.lang.String	getDefaultDescription() Return a reasonable default description for this script step.
protected java.lang.Object	getTarget(java.lang.reflect.Method m) Return the target of the method invocation.
static boolean	isPropertyMethod(java.lang.reflect.Method m) Returns whether the given method is a property accessor.
void	setComponentID(java.lang.String id) Set the component reference ID used by method invocation.

Methods inherited from class abbot.script.Call

disambiguateMethod, evaluateParameter, evaluateParameters, getArgs, getArguments, getArgumentsDescription, getEncodedArguments, getMethod, getMethodName, getMethods, getTargetClass, getTargetClassName, getUsage, getXMLTag, invoke, resolveMethod, resolveMethods, runStep, setArguments, setArguments, setMethodName, setTargetClassName

Methods inherited from class abbot.script.Step

addAttributes, addContent, createAttributeMap, createStep, createStep, getDescription, getResolver, parseAttributes, resolveClass, resolveTester, run, setDescription, setScriptError, simpleClassName, toEditableString, toString, toXML, toXMLString, usage, usage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertyCall

public PropertyCall(Resolver resolver,
            java.util.Map attributes)

Create a PropertyCall based on loaded XML attributes.

PropertyCall

public PropertyCall(Resolver resolver,
            java.lang.String description,
            java.lang.String className,
            java.lang.String methodName,
            java.lang.String[] args)

Create a PropertyCall based on a static invocation on an arbitrary class.

PropertyCall

public PropertyCall(Resolver resolver,
            java.lang.String description,
            java.lang.String methodName,
            java.lang.String id)

Create a PropertyCall with a Component target. The target class name is derived from the given component reference ID.

Method Detail

getComponentID

public java.lang.String getComponentID()

Return the component reference ID used by this method invocation.

setComponentID

public void setComponentID(java.lang.String id)

Set the component reference ID used by method invocation. The class of the component referenced by the component reference will replace the current target class.

getAttributes

public java.util.Map getAttributes()

Save attributes specific to this Step class.

Overrides:

getAttributes in class Call

getTarget

protected java.lang.Object getTarget(java.lang.reflect.Method m)
                              throws java.lang.Throwable

Return the target of the method invocation.

Overrides:

getTarget in class Call

Throws:

java.lang.Throwable

isPropertyMethod

public static boolean isPropertyMethod(java.lang.reflect.Method m)

Returns whether the given method is a property accessor. In addition to standard is/get/has property accessors, this includes pseudo-property methods on ComponentTester objects.

getDefaultDescription

public java.lang.String getDefaultDescription()

Description copied from class: Step

Return a reasonable default description for this script step. This value is used in the absence of an explicit description.

Overrides:

getDefaultDescription in class Call