java.lang.Object
- org.jbehave.core.configuration.Keywords

Direct Known Subclasses:

LocalizedKeywords
```
public class Keywords
extends Object
```
Provides the keywords which allow parsers to find steps in stories and match those steps with candidates through the annotations. It provides the starting words (Given, When, Then And, "!--") using in parsing, as well as providing keywords used in reporting.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Keywords.KeywordNotFound

static class Keywords.StartingWordNotFound

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`AFTER`
`static String`	`AND`
`static String`	`AS_A`
`static String`	`BEFORE`
`static String`	`COMPOSITE`
`static String`	`DRY_RUN`
`static String`	`DURATION`
`static String`	`EXAMPLES_TABLE`
`static String`	`EXAMPLES_TABLE_HEADER_SEPARATOR`
`static String`	`EXAMPLES_TABLE_IGNORABLE_SEPARATOR`
`static String`	`EXAMPLES_TABLE_ROW`
`static String`	`EXAMPLES_TABLE_VALUE_SEPARATOR`
`static String`	`FAILED`
`static String`	`GIVEN`
`static String`	`GIVEN_STORIES`
`static String`	`I_WANT_TO`
`static String`	`IGNORABLE`
`static String`	`IN_ORDER_TO`
`static List<String>`	`KEYWORDS`
`static String`	`LIFECYCLE`
`static String`	`META`
`static String`	`META_FILTER`
`static String`	`META_PROPERTY`
`static String`	`NARRATIVE`
`static String`	`NO`
`static String`	`NOT_PERFORMED`
`static String`	`OUTCOME`
`static String`	`OUTCOME_ANY`
`static String`	`OUTCOME_DESCRIPTION`
`static String`	`OUTCOME_FAILURE`
`static String`	`OUTCOME_MATCHER`
`static String`	`OUTCOME_SUCCESS`
`static String`	`OUTCOME_VALUE`
`static String`	`OUTCOME_VERIFIED`
`static String`	`PENDING`
`static String`	`PRIORITY`
`static String`	`SCENARIO`
`static String`	`SCOPE`
`static String`	`SCOPE_SCENARIO`
`static String`	`SCOPE_STEP`
`static String`	`SCOPE_STORY`
`static String`	`SO_THAT`
`static String`	`STORY_CANCELLED`
`static String`	`THEN`
`static String`	`WHEN`
`static String`	`YES`

Constructor Summary

Constructors
Constructor	Description
`Keywords()`	Creates Keywords with default values `defaultKeywords()`
`Keywords(Map<String,String> keywords)`	Creates Keywords with provided keywords Map and Encoding

Method Summary

Modifier and Type	Method	Description
`String`	`after()`
`String`	`and()`
`String`	`asA()`
`String`	`before()`
`String`	`composite()`
`static Map<String,String>`	`defaultKeywords()`
`String`	`dryRun()`
`String`	`duration()`
`String`	`examplesTable()`
`String`	`examplesTableHeaderSeparator()`
`String`	`examplesTableIgnorableSeparator()`
`String`	`examplesTableRow()`
`String`	`examplesTableValueSeparator()`
`String`	`failed()`
`String`	`given()`
`String`	`givenStories()`
`String`	`ignorable()`
`String`	`inOrderTo()`
`boolean`	`isAndStep(String stepAsString)`
`boolean`	`isIgnorableStep(String stepAsString)`
`String`	`iWantTo()`
`String`	`lifecycle()`
`String`	`meta()`
`String`	`metaFilter()`
`String`	`metaProperty()`
`String`	`narrative()`
`String`	`no()`
`String`	`notPerformed()`
`String`	`outcome()`
`String`	`outcomeAny()`
`String`	`outcomeDescription()`
`String`	`outcomeFailure()`
`List<String>`	`outcomeFields()`
`String`	`outcomeMatcher()`
`String`	`outcomeSuccess()`
`String`	`outcomeValue()`
`String`	`outcomeVerified()`
`String`	`pending()`
`String`	`priority()`
`String`	`scenario()`
`String`	`scope()`
`String`	`scopeScenario()`
`String`	`scopeStep()`
`String`	`scopeStory()`
`String`	`soThat()`
`String`	`startingWord(String stepAsString)`
`String`	`startingWord(String stepAsString, StepType stepType)`
`String`	`startingWordFor(StepType stepType)`
`Stream<String>`	`startingWords(Predicate<StepType> stepTypeFilter)`
`Map<StepType,String>`	`startingWordsByType()`
`String[]`	`startingWordsFor(StepType stepType)`
`boolean`	`stepStartsWithWord(String step, String word)`
`boolean`	`stepStartsWithWords(String step, String... words)`
`StepType`	`stepTypeFor(String stepAsString)`
`String`	`stepWithoutStartingWord(String stepAsString)`
`String`	`stepWithoutStartingWord(String stepAsString, StepType stepType)`
`String`	`storyCancelled()`
`String[]`	`synonymsOf(String word)`
`String`	`then()`
`String`	`toString()`
`String`	`when()`
`String`	`yes()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

META
```
public static final String META
```
See Also:

Constant Field Values

META_PROPERTY

public static final String META_PROPERTY

See Also:: Constant Field Values

NARRATIVE
```
public static final String NARRATIVE
```
See Also:

Constant Field Values

IN_ORDER_TO
```
public static final String IN_ORDER_TO
```
See Also:

Constant Field Values

AS_A
```
public static final String AS_A
```
See Also:

Constant Field Values

I_WANT_TO
```
public static final String I_WANT_TO
```
See Also:

Constant Field Values

SO_THAT
```
public static final String SO_THAT
```
See Also:

Constant Field Values

SCENARIO
```
public static final String SCENARIO
```
See Also:

Constant Field Values

GIVEN_STORIES

public static final String GIVEN_STORIES

See Also:: Constant Field Values

LIFECYCLE
```
public static final String LIFECYCLE
```
See Also:

Constant Field Values

BEFORE
```
public static final String BEFORE
```
See Also:

Constant Field Values

AFTER
```
public static final String AFTER
```
See Also:

Constant Field Values

EXAMPLES_TABLE

public static final String EXAMPLES_TABLE

See Also:: Constant Field Values

EXAMPLES_TABLE_ROW

public static final String EXAMPLES_TABLE_ROW

See Also:: Constant Field Values

EXAMPLES_TABLE_HEADER_SEPARATOR

public static final String EXAMPLES_TABLE_HEADER_SEPARATOR

See Also:: Constant Field Values

EXAMPLES_TABLE_VALUE_SEPARATOR

public static final String EXAMPLES_TABLE_VALUE_SEPARATOR

See Also:: Constant Field Values

EXAMPLES_TABLE_IGNORABLE_SEPARATOR

public static final String EXAMPLES_TABLE_IGNORABLE_SEPARATOR

See Also:: Constant Field Values

GIVEN
```
public static final String GIVEN
```
See Also:

Constant Field Values

WHEN
```
public static final String WHEN
```
See Also:

Constant Field Values

THEN
```
public static final String THEN
```
See Also:

Constant Field Values

AND
```
public static final String AND
```
See Also:

Constant Field Values

IGNORABLE
```
public static final String IGNORABLE
```
See Also:

Constant Field Values

COMPOSITE
```
public static final String COMPOSITE
```
See Also:

Constant Field Values

PRIORITY
```
public static final String PRIORITY
```
See Also:

Constant Field Values

PENDING
```
public static final String PENDING
```
See Also:

Constant Field Values

NOT_PERFORMED

public static final String NOT_PERFORMED

See Also:: Constant Field Values

FAILED
```
public static final String FAILED
```
See Also:

Constant Field Values

DRY_RUN
```
public static final String DRY_RUN
```
See Also:

Constant Field Values

STORY_CANCELLED

public static final String STORY_CANCELLED

See Also:: Constant Field Values

DURATION
```
public static final String DURATION
```
See Also:

Constant Field Values

SCOPE
```
public static final String SCOPE
```
See Also:

Constant Field Values

SCOPE_STEP
```
public static final String SCOPE_STEP
```
See Also:

Constant Field Values

SCOPE_SCENARIO

public static final String SCOPE_SCENARIO

See Also:: Constant Field Values

SCOPE_STORY
```
public static final String SCOPE_STORY
```
See Also:

Constant Field Values

OUTCOME
```
public static final String OUTCOME
```
See Also:

Constant Field Values

OUTCOME_ANY
```
public static final String OUTCOME_ANY
```
See Also:

Constant Field Values

OUTCOME_SUCCESS

public static final String OUTCOME_SUCCESS

See Also:: Constant Field Values

OUTCOME_FAILURE

public static final String OUTCOME_FAILURE

See Also:: Constant Field Values

OUTCOME_DESCRIPTION

public static final String OUTCOME_DESCRIPTION

See Also:: Constant Field Values

OUTCOME_VALUE

public static final String OUTCOME_VALUE

See Also:: Constant Field Values

OUTCOME_MATCHER

public static final String OUTCOME_MATCHER

See Also:: Constant Field Values

OUTCOME_VERIFIED

public static final String OUTCOME_VERIFIED

See Also:: Constant Field Values

META_FILTER
```
public static final String META_FILTER
```
See Also:

Constant Field Values

YES
```
public static final String YES
```
See Also:

Constant Field Values

NO
```
public static final String NO
```
See Also:

Constant Field Values

KEYWORDS

public static final List<String> KEYWORDS

Constructor Detail
- Keywords
```
public Keywords()
```
  Creates Keywords with default values defaultKeywords()
- Keywords
```
public Keywords(Map<String,String> keywords)
```
  Creates Keywords with provided keywords Map and Encoding
  
  Parameters:
  
  keywords - the Map of keywords indexed by their name

Method Detail

defaultKeywords

public static Map<String,String> defaultKeywords()

meta
```
public String meta()
```

metaProperty
```
public String metaProperty()
```

narrative
```
public String narrative()
```

inOrderTo
```
public String inOrderTo()
```

asA
```
public String asA()
```

iWantTo
```
public String iWantTo()
```

soThat
```
public String soThat()
```

scenario
```
public String scenario()
```

givenStories
```
public String givenStories()
```

lifecycle
```
public String lifecycle()
```

before
```
public String before()
```

after
```
public String after()
```

examplesTable
```
public String examplesTable()
```

examplesTableRow
```
public String examplesTableRow()
```

examplesTableHeaderSeparator

public String examplesTableHeaderSeparator()

examplesTableValueSeparator

public String examplesTableValueSeparator()

examplesTableIgnorableSeparator

public String examplesTableIgnorableSeparator()

given
```
public String given()
```

when
```
public String when()
```

then
```
public String then()
```

and
```
public String and()
```

ignorable
```
public String ignorable()
```

composite
```
public String composite()
```

priority
```
public String priority()
```

pending
```
public String pending()
```

notPerformed
```
public String notPerformed()
```

failed
```
public String failed()
```

dryRun
```
public String dryRun()
```

storyCancelled
```
public String storyCancelled()
```

duration
```
public String duration()
```

scope
```
public String scope()
```

scopeStep
```
public String scopeStep()
```

scopeScenario
```
public String scopeScenario()
```

scopeStory
```
public String scopeStory()
```

outcome
```
public String outcome()
```

outcomeAny
```
public String outcomeAny()
```

outcomeSuccess
```
public String outcomeSuccess()
```

outcomeFailure
```
public String outcomeFailure()
```

outcomeDescription
```
public String outcomeDescription()
```

outcomeValue
```
public String outcomeValue()
```

outcomeMatcher
```
public String outcomeMatcher()
```

outcomeVerified
```
public String outcomeVerified()
```

outcomeFields
```
public List<String> outcomeFields()
```

metaFilter
```
public String metaFilter()
```

yes
```
public String yes()
```

no
```
public String no()
```

synonymsOf

public String[] synonymsOf(String word)

startingWords

public Stream<String> startingWords(Predicate<StepType> stepTypeFilter)

startingWordsByType

public Map<StepType,String> startingWordsByType()

isAndStep

public boolean isAndStep(String stepAsString)

isIgnorableStep

public boolean isIgnorableStep(String stepAsString)

stepWithoutStartingWord

public String stepWithoutStartingWord(String stepAsString,
                                      StepType stepType)

stepWithoutStartingWord

public String stepWithoutStartingWord(String stepAsString)

startingWord

public String startingWord(String stepAsString,
                           StepType stepType)
                    throws Keywords.StartingWordNotFound

Throws:: Keywords.StartingWordNotFound

startingWord

public String startingWord(String stepAsString)
                    throws Keywords.StartingWordNotFound

Throws:: Keywords.StartingWordNotFound

stepTypeFor

public StepType stepTypeFor(String stepAsString)
                     throws Keywords.StartingWordNotFound

Throws:: Keywords.StartingWordNotFound

stepStartsWithWord

public boolean stepStartsWithWord(String step,
                                  String word)

stepStartsWithWords

public boolean stepStartsWithWords(String step,
                                   String... words)

startingWordFor

public String startingWordFor(StepType stepType)

startingWordsFor

public String[] startingWordsFor(StepType stepType)

toString
```
public String toString()
```
Overrides:

toString in class Object

Modifier and Type	Class	Description
`static class`	`Keywords.KeywordNotFound`
`static class`	`Keywords.StartingWordNotFound`

Class Keywords

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

META

META_PROPERTY

NARRATIVE

IN_ORDER_TO

AS_A

I_WANT_TO

SO_THAT

SCENARIO

GIVEN_STORIES

LIFECYCLE

BEFORE

AFTER

EXAMPLES_TABLE

EXAMPLES_TABLE_ROW

EXAMPLES_TABLE_HEADER_SEPARATOR

EXAMPLES_TABLE_VALUE_SEPARATOR

EXAMPLES_TABLE_IGNORABLE_SEPARATOR

GIVEN

WHEN

THEN

AND

IGNORABLE

COMPOSITE

PRIORITY

PENDING

NOT_PERFORMED

FAILED

DRY_RUN

STORY_CANCELLED

DURATION

SCOPE

SCOPE_STEP

SCOPE_SCENARIO

SCOPE_STORY

OUTCOME

OUTCOME_ANY

OUTCOME_SUCCESS

OUTCOME_FAILURE

OUTCOME_DESCRIPTION

OUTCOME_VALUE

OUTCOME_MATCHER

OUTCOME_VERIFIED

META_FILTER

YES

NO

KEYWORDS

Constructor Detail

Keywords

Keywords

Method Detail

defaultKeywords

meta

metaProperty

narrative

inOrderTo

asA

iWantTo

soThat

scenario

givenStories

lifecycle

before

after

examplesTable

examplesTableRow

examplesTableHeaderSeparator

examplesTableValueSeparator

examplesTableIgnorableSeparator

given

when

then

and

ignorable