org.jbehave.scenario.definition
Class KeyWords

java.lang.Object
  extended by org.jbehave.scenario.definition.KeyWords
Direct Known Subclasses:
I18nKeyWords

public class KeyWords
extends java.lang.Object

Provides the keywords which allow parsers to find steps in scenarios and match those steps with candidates through the annotations (Given, When and Then) or though other keywords (And, "!--"). It also provides keywords used in reporting.


Nested Class Summary
static class KeyWords.InsufficientKeywordsException
           
static class KeyWords.KeywordNotFoundException
           
 
Field Summary
static java.lang.String AND
           
static java.lang.String AS_A
           
static java.lang.String EXAMPLES_TABLE
           
static java.lang.String EXAMPLES_TABLE_ROW
           
static java.lang.String FAILED
           
static java.lang.String GIVEN
           
static java.lang.String GIVEN_SCENARIOS
           
static java.lang.String I_WANT_TO
           
static java.lang.String IGNORABLE
           
static java.lang.String IN_ORDER_TO
           
static java.util.List<java.lang.String> KEYWORDS
           
static java.lang.String NARRATIVE
           
static java.lang.String NOT_PERFORMED
           
static java.lang.String PENDING
           
static java.lang.String SCENARIO
           
static java.lang.String THEN
           
static java.lang.String WHEN
           
 
Constructor Summary
KeyWords()
          Creates KeyWords with default values defaultKeywords().
KeyWords(java.util.Map<java.lang.String,java.lang.String> keywords)
          Creates KeyWords with provided values and default encoder
KeyWords(java.util.Map<java.lang.String,java.lang.String> keywords, StringEncoder encoder)
          Creates a KeyWords from the map provided.
KeyWords(java.lang.String scenario, java.lang.String givenScenarios, java.lang.String examplesTable, java.lang.String given, java.lang.String when, java.lang.String then, java.lang.String... others)
          Deprecated. Use KeyWords(Map, StringEncoder)
 
Method Summary
 java.lang.String and()
           
 java.lang.String asA()
           
static java.util.Map<java.lang.String,java.lang.String> defaultKeywords()
           
 java.lang.String encode(java.lang.String value)
           
 java.lang.String examplesTable()
           
 java.lang.String examplesTableRow()
           
 java.lang.String failed()
           
 java.lang.String given()
           
 java.lang.String givenScenarios()
           
 java.lang.String ignorable()
           
 java.lang.String inOrderTo()
           
 java.lang.String iWantTo()
           
 java.lang.String narrative()
           
 java.lang.String notPerformed()
           
 java.lang.String[] others()
           
 java.lang.String pending()
           
 java.lang.String scenario()
           
 java.lang.String then()
           
 java.lang.String when()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NARRATIVE

public static final java.lang.String NARRATIVE
See Also:
Constant Field Values

IN_ORDER_TO

public static final java.lang.String IN_ORDER_TO
See Also:
Constant Field Values

AS_A

public static final java.lang.String AS_A
See Also:
Constant Field Values

I_WANT_TO

public static final java.lang.String I_WANT_TO
See Also:
Constant Field Values

SCENARIO

public static final java.lang.String SCENARIO
See Also:
Constant Field Values

GIVEN_SCENARIOS

public static final java.lang.String GIVEN_SCENARIOS
See Also:
Constant Field Values

EXAMPLES_TABLE

public static final java.lang.String EXAMPLES_TABLE
See Also:
Constant Field Values

GIVEN

public static final java.lang.String GIVEN
See Also:
Constant Field Values

WHEN

public static final java.lang.String WHEN
See Also:
Constant Field Values

THEN

public static final java.lang.String THEN
See Also:
Constant Field Values

AND

public static final java.lang.String AND
See Also:
Constant Field Values

IGNORABLE

public static final java.lang.String IGNORABLE
See Also:
Constant Field Values

PENDING

public static final java.lang.String PENDING
See Also:
Constant Field Values

NOT_PERFORMED

public static final java.lang.String NOT_PERFORMED
See Also:
Constant Field Values

FAILED

public static final java.lang.String FAILED
See Also:
Constant Field Values

EXAMPLES_TABLE_ROW

public static final java.lang.String EXAMPLES_TABLE_ROW
See Also:
Constant Field Values

KEYWORDS

public static final java.util.List<java.lang.String> KEYWORDS
Constructor Detail

KeyWords

public KeyWords()
Creates KeyWords with default values defaultKeywords().


KeyWords

public KeyWords(java.util.Map<java.lang.String,java.lang.String> keywords)
Creates KeyWords with provided values and default encoder

Parameters:
keywords - the Map of keywords indexed by their name

KeyWords

public KeyWords(java.util.Map<java.lang.String,java.lang.String> keywords,
                StringEncoder encoder)
Creates a KeyWords from the map provided.

Parameters:
keywords - the Map of keywords indexed by their name
encoder - the StringEncoder used to encode the values

KeyWords

public KeyWords(java.lang.String scenario,
                java.lang.String givenScenarios,
                java.lang.String examplesTable,
                java.lang.String given,
                java.lang.String when,
                java.lang.String then,
                java.lang.String... others)
Deprecated. Use KeyWords(Map, StringEncoder)

Legacy constructor for KeyWords that provids explicitly the keywords values. The others vararg must include 10 additional keywords (and, ignorable, pending, notPerformed, failed, examplesTableRow, narrative, inOrderTo, asA, iWantTo).

Parameters:
scenario -
givenScenarios -
examplesTable -
given -
when -
then -
others -
Method Detail

defaultKeywords

public static java.util.Map<java.lang.String,java.lang.String> defaultKeywords()

narrative

public java.lang.String narrative()

inOrderTo

public java.lang.String inOrderTo()

asA

public java.lang.String asA()

iWantTo

public java.lang.String iWantTo()

scenario

public java.lang.String scenario()

givenScenarios

public java.lang.String givenScenarios()

examplesTable

public java.lang.String examplesTable()

given

public java.lang.String given()

when

public java.lang.String when()

then

public java.lang.String then()

and

public java.lang.String and()

ignorable

public java.lang.String ignorable()

pending

public java.lang.String pending()

notPerformed

public java.lang.String notPerformed()

failed

public java.lang.String failed()

examplesTableRow

public java.lang.String examplesTableRow()

others

public java.lang.String[] others()

encode

public java.lang.String encode(java.lang.String value)


Copyright © 2003-2010. All Rights Reserved.