Package com.rs.seagull.emulator.api

Class StopConditions.EndMarkerStopCondition

java.lang.Object

com.rs.seagull.emulator.api.StopConditions.StopConditionAdapter

com.rs.seagull.emulator.api.StopConditions.EndMarkerStopCondition

All Implemented Interfaces:

Condition, Table.StopCondition

Enclosing class:

StopConditions

public static class StopConditions.EndMarkerStopCondition
extends StopConditions.StopConditionAdapter

A StopCondition where the stop condition is a value in a field.

Version:

$Id: CJL2CodeTemplates.xml,v 1.2 2011/02/16 16:13:58 MRomijn Exp $

Author:

mromijn

Field Summary

Fields

Modifier and Type	Field	Description
final String	markerField	The name of the marker column field
final String	markerValue	The value the marker field contains when the end of the table is reached

Fields inherited from class com.rs.seagull.emulator.api.StopConditions.StopConditionAdapter

contains, ignoreCase, jsIsTrueScript, LOG, maxPages, session, testBefore

Constructor Summary

Constructors

Constructor	Description
EndMarkerStopCondition(Session session, boolean ignoreCase, boolean testBefore, boolean contains, String markerField, String markerValue)	Create an EndMarkerStopCondition where the stop condition is a value in a field.

Method Summary

Modifier and Type	Method	Description
boolean	innerIsTrue()	Returns true if the Condition is satisfied.

Methods inherited from class com.rs.seagull.emulator.api.StopConditions.StopConditionAdapter

doTestBeforeProcessingPage, eachPage, eachRow, incrementPageCount, initialize, isTrue, isTrue, setJavascriptIsTrueScript

Methods inherited from class java.lang.Object

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

Field Details

markerField

public final String markerField

The name of the marker column field

markerValue

public final String markerValue

The value the marker field contains when the end of the table is reached

Constructor Details

EndMarkerStopCondition

public EndMarkerStopCondition(Session session,
 boolean ignoreCase,
 boolean testBefore,
 boolean contains,
 String markerField,
 String markerValue)

Create an EndMarkerStopCondition where the stop condition is a value in a field.

Parameters:

session - The session.

ignoreCase - True if the text comparison should ignore case.

testBefore - True if the test should be done before processing the page.

contains - True if the text comparison should be contains() rather than equals().

markerField - The name of the marker column field.

markerValue - The value the marker field contains when the end of the table is reached.

Method Details

innerIsTrue

public boolean innerIsTrue()

Description copied from class: StopConditions.StopConditionAdapter

Returns true if the Condition is satisfied.

Specified by:

innerIsTrue in class StopConditions.StopConditionAdapter

Returns:

true if the Condition is satisfied.