View Javadoc

1   /*
2       Jameleon - An automation testing tool..
3       Copyright (C) 2006 Christian W. Hargraves (engrean@hotmail.com)
4       
5       This library is free software; you can redistribute it and/or
6       modify it under the terms of the GNU Lesser General Public
7       License as published by the Free Software Foundation; either
8       version 2.1 of the License, or (at your option) any later version.
9   
10      This library is distributed in the hope that it will be useful,
11      but WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13      Lesser General Public License for more details.
14  
15      You should have received a copy of the GNU Lesser General Public
16      License along with this library; if not, write to the Free Software
17      Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19  package net.sf.jameleon.util;
20  
21  /***
22   * A way to communicate with the plugin for matching text, and setting it in the context
23   */
24  public interface TextMatcher{
25  
26      /***
27       * Gets the current screen as text. This method should define logic needed
28       * to get the text representation of the screen.
29       * 
30       * @return String
31       */
32      public String getCurrentScreenAsText();
33      /***
34       * Gets the matching regular expression text.
35       * @param text - The text to run the regular expression against
36       * @param regex - The regular expression
37       * @param group - The group number of the regular expression to match against.
38       * If the regex has no parens, then the group would be zero.
39       * 
40       * @return String
41       */
42      public String getMatchingRegexText(String text, String regex, int group);
43      /***
44       * Sets the variable in the context.
45       * @param key - The context variable name
46       * @param value - The variable value.
47       */
48      public void setVariable(String key, Object value);
49  
50  }