abbot.script
Class Sample

java.lang.Object
  extended by abbot.script.Step
      extended by abbot.script.Call
          extended by abbot.script.PropertyCall
              extended by abbot.script.Sample
All Implemented Interfaces:
XMLConstants, XMLifiable, Serializable

public class Sample
extends PropertyCall

Encapsulate capture of a value. Usage:

<sample property="..." method="assertXXX" [class="..."]>
<sample property="..." method="(get|is|has)XXX" component="component_id">
The sample step stores the value found from the given method ComponentTester class; the class tag is required for methods based on a class derived from ComponentTester; the class tag indicates the Component class, not the Tester class (the appropriate tester class will be derived automatically). The second format indicates a property sample on the given component. In both cases, the result of the invocation will be saved in the current Resolver as a property with the given property name.

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
Sample(Resolver resolver, Map attributes)
           
Sample(Resolver resolver, String description, String methodName, String id, String propName)
          Component property sample.
Sample(Resolver resolver, String description, String className, String methodName, String[] args, String propName)
          Static method property sample.
 
Method Summary
 Map getAttributes()
          Save attributes specific to this Step class.
 String getDefaultDescription()
          Return a reasonable default description for this script step.
 String getPropertyName()
           
 String getUsage()
          Provide a usage String for this step.
 String getXMLTag()
          Define the XML tag to use for this script step.
protected  Object invoke()
          Store the results of the invocation in the designated property as a String-encoded value.
 void setPropertyName(String name)
           
 
Methods inherited from class abbot.script.PropertyCall
getComponentID, getTarget, isPropertyMethod, setComponentID
 
Methods inherited from class abbot.script.Call
disambiguateMethod, evaluateParameter, evaluateParameters, getArgs, getArguments, getArgumentsDescription, getEncodedArguments, getMethod, getMethodName, getMethods, getTargetClass, getTargetClassName, resolveMethod, resolveMethods, runStep, setArguments, setArguments, setMethodName, setTargetClassName
 
Methods inherited from class abbot.script.Step
addAttributes, addContent, createAttributeMap, createStep, createStep, getDescription, getResolver, parseStepAttributes, 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

Sample

public Sample(Resolver resolver,
              Map attributes)

Sample

public Sample(Resolver resolver,
              String description,
              String methodName,
              String id,
              String propName)
Component property sample.


Sample

public Sample(Resolver resolver,
              String description,
              String className,
              String methodName,
              String[] args,
              String propName)
Static method property sample.

Method Detail

getAttributes

public Map getAttributes()
Description copied from class: PropertyCall
Save attributes specific to this Step class.

Overrides:
getAttributes in class PropertyCall

getDefaultDescription

public 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 PropertyCall

getUsage

public String getUsage()
Description copied from class: Step
Provide a usage String for this step.

Overrides:
getUsage in class Call

getXMLTag

public String getXMLTag()
Description copied from class: Step
Define the XML tag to use for this script step.

Overrides:
getXMLTag in class Call

setPropertyName

public void setPropertyName(String name)

getPropertyName

public String getPropertyName()

invoke

protected Object invoke()
                 throws Throwable
Store the results of the invocation in the designated property as a String-encoded value.

Overrides:
invoke in class Call
Throws:
Throwable


Copyright © 2002-2008 Timothy Wall. All Rights Reserved.
Abbot is hosted on

SourceForge