eteg.sinon.core
Class PositioningStep

java.lang.Object
  extended by eteg.sinon.core.PositioningStep
All Implemented Interfaces:
Step

public class PositioningStep
extends java.lang.Object
implements Step

Class that represents positioning steps inside a page in Sinon.

The properties of instances of this class are:

Version:
$Revision: 1.2 $
Author:
Thiago H. de Paula Figueiredo, Last modified by $Author: thiagohp $

Field Summary
static boolean BACKWARD
          Constants used to specify a backward search.
static boolean FORWARD
          Constants used to specify a forward search.
static java.lang.String FROM
          Constant that defines the from positioning step type.
static java.lang.String JUMP
          Constant that defines the jump positioning step type.
static java.lang.String LOOP
          Constant that defines the loop positioning step type.
static java.lang.String TO
          Constant that defines the to positioning step type.
 
Constructor Summary
PositioningStep()
          Constructor without parameters.
 
Method Summary
 java.lang.String getBefore()
          Returns the value of the before property.
 boolean getDirection()
          Returns the value of the direction property.
 java.lang.String getReference()
          Returns the value of the reference property.
 java.lang.String getType()
          Returns the value of the type property.
 boolean isAction()
          Returns false.
 boolean isDataExtraction()
          Returns false.
 boolean isFailIfFound()
          Returns the value of the failIfFound property.
 boolean isFrom()
          Tells if the type of this positioning step is from.
 boolean isJump()
          Tells if the type of this positioning step is jump.
 boolean isLoop()
          Diz se este passo é um loop.
 boolean isMustTrimReference()
          Returns the value of the mustTrimReference property.
 boolean isPositioningStep()
          Returns true.
 boolean isTo()
          Tells if the type of this positioning step is to.
 void setBefore(java.lang.String before)
          Sets the value of the before property.
 void setDirection(boolean direction)
          Sets the value of the direction property.
 void setFailIfFound(boolean failIfFound)
          Sets the value of the failIfFound property.
 void setMustTrimReference(boolean mustTrimReference)
          Sets the value of the mustTrimReference property.
 void setReference(java.lang.String reference)
          Sets the value of the reference property.
 void setType(java.lang.String type)
          Sets the value of the type property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

JUMP

public static final java.lang.String JUMP
Constant that defines the jump positioning step type.

See Also:
Constant Field Values

FROM

public static final java.lang.String FROM
Constant that defines the from positioning step type.

See Also:
Constant Field Values

TO

public static final java.lang.String TO
Constant that defines the to positioning step type.

See Also:
Constant Field Values

LOOP

public static final java.lang.String LOOP
Constant that defines the loop positioning step type.

See Also:
Constant Field Values

FORWARD

public static final boolean FORWARD
Constants used to specify a forward search.

See Also:
Constant Field Values

BACKWARD

public static final boolean BACKWARD
Constants used to specify a backward search.

See Also:
Constant Field Values
Constructor Detail

PositioningStep

public PositioningStep()
Constructor without parameters.

Method Detail

getBefore

public java.lang.String getBefore()
Returns the value of the before property.

Returns:
a String.

setBefore

public void setBefore(java.lang.String before)
Sets the value of the before property.

Parameters:
before - the new before value.

getType

public java.lang.String getType()
Returns the value of the type property.

Returns:
a String.

setType

public void setType(java.lang.String type)
Sets the value of the type property.

Parameters:
type - the new type value.

getReference

public java.lang.String getReference()
Returns the value of the reference property.

Returns:
a String.

setReference

public void setReference(java.lang.String reference)
Sets the value of the reference property.

Parameters:
reference - the new reference value.

getDirection

public boolean getDirection()
Returns the value of the direction property.

Returns:
FORWARD or BACKWARD.

setDirection

public void setDirection(boolean direction)
Sets the value of the direction property.

Parameters:
{@link - #FORWARD} or BACKWARD.

isFailIfFound

public boolean isFailIfFound()
Returns the value of the failIfFound property.

Returns:
a boolean.

setFailIfFound

public void setFailIfFound(boolean failIfFound)
Sets the value of the failIfFound property.

Parameters:
failIfFound - the new failIfFound value.

isMustTrimReference

public boolean isMustTrimReference()
Returns the value of the mustTrimReference property.

Returns:
a String.

setMustTrimReference

public void setMustTrimReference(boolean mustTrimReference)
Sets the value of the mustTrimReference property.

Parameters:
mustTrimReference - the new mustTrimReference value.

isDataExtraction

public boolean isDataExtraction()
Returns false.

Specified by:
isDataExtraction in interface Step
Returns:
false

isPositioningStep

public boolean isPositioningStep()
Returns true.

Specified by:
isPositioningStep in interface Step
Returns:
true

isLoop

public boolean isLoop()
Diz se este passo é um loop.

Specified by:
isLoop in interface Step
Returns:
true se este passo é um loop, false caso contrário.

isAction

public boolean isAction()
Returns false.

Specified by:
isAction in interface Step
Returns:
false.

isFrom

public boolean isFrom()
Tells if the type of this positioning step is from.

Returns:
true if the type of this positioning step is from, false otherwise.

isTo

public boolean isTo()
Tells if the type of this positioning step is to.

Returns:
true if the type of this positioning step is to, false otherwise.

isJump

public boolean isJump()
Tells if the type of this positioning step is jump.

Returns:
true if the type of this positioning step is jump, false otherwise.


Copyright © 2004-2005 ETEG Internet Ltda.. All Rights Reserved.