|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.jbehave.core.steps.StepFinder
public class StepFinder
StepFinder is reponsible for finding and prioritising step candidates or
finding steps instances from CandidateSteps, which are created using
an InjectableStepsFactory.
The StepCandidates are responsible for the matching of a particular
textual step and are sometimes represented as Stepdocs, each of which
is simply a facade documenting a candidate. The candidates can be prioritised
via an injectable StepFinder.PrioritisingStrategy, defaulting to
StepFinder.ByPriorityField. A more sophisticated strategy that can be used is
the StepFinder.ByLevenshteinDistance.
| Nested Class Summary | |
|---|---|
static class |
StepFinder.ByLevenshteinDistance
Strategy to priorise candidate steps by Levenshtein Distance |
static class |
StepFinder.ByPriorityField
Strategy to priorise step candidates by the StepCandidate.getPriority() field which is settable in the
Given, When, Then annotations. |
static interface |
StepFinder.PrioritisingStrategy
Defines the priorising strategy of step candidates |
| Constructor Summary | |
|---|---|
StepFinder()
Creates a StepFinder with a StepFinder.ByPriorityField strategy |
|
StepFinder(StepFinder.PrioritisingStrategy prioritisingStrategy)
Creates a StepFinder with a custom strategy |
|
| Method Summary | |
|---|---|
List<StepCandidate> |
collectCandidates(List<CandidateSteps> candidateSteps)
Collects a list of step candidates from CandidateSteps instances. |
List<Stepdoc> |
findMatching(String stepAsText,
List<CandidateSteps> candidateSteps)
Finds matching steps, represented as Stepdocs, for a given
textual step and a list of CandidateSteps. |
List<StepCandidate> |
prioritise(String stepAsText,
List<StepCandidate> candidates)
Prioritises the list of step candidates that match a given step. |
List<Stepdoc> |
stepdocs(List<CandidateSteps> candidateSteps)
Returns the stepdocs for the candidates collected from the given CandidateSteps. |
List<Object> |
stepsInstances(List<CandidateSteps> candidateSteps)
Returns the steps instances associated to CandidateSteps |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public StepFinder()
StepFinder.ByPriorityField strategy
public StepFinder(StepFinder.PrioritisingStrategy prioritisingStrategy)
prioritisingStrategy - the PrioritisingStrategy| Method Detail |
|---|
public List<Stepdoc> stepdocs(List<CandidateSteps> candidateSteps)
CandidateSteps.
candidateSteps - the List of CandidateSteps
StepCandidate.
public List<Stepdoc> findMatching(String stepAsText,
List<CandidateSteps> candidateSteps)
Stepdocs, for a given
textual step and a list of CandidateSteps.
stepAsText - the textual stepcandidateSteps - the List of CandidateSteps
StepCandidate.public List<Object> stepsInstances(List<CandidateSteps> candidateSteps)
candidateSteps - the List of CandidateSteps
public List<StepCandidate> collectCandidates(List<CandidateSteps> candidateSteps)
CandidateSteps instances.
candidateSteps - the list CandidateSteps instances
StepCandidate
public List<StepCandidate> prioritise(String stepAsText,
List<StepCandidate> candidates)
stepAsText - the textual step to matchcandidates - the List of StepCandidate
StepFinder.PrioritisingStrategy.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||