org.jbehave.core.steps

Class Stepdoc

java.lang.Object

org.jbehave.core.steps.Stepdoc

All Implemented Interfaces:

java.lang.Comparable<Stepdoc>

public class Stepdoc
extends java.lang.Object
implements java.lang.Comparable<Stepdoc>

A Stepdoc represents the documentation on a single StepCandidate, which includes:

• the step type
• the pattern to match the step candidate that is configured in the annotation
• the method in the steps instance class
• the steps instance class

Constructor Summary

Constructors

Constructor and Description
Stepdoc(StepCandidate candidate)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Stepdoc that)
java.lang.reflect.Method	getMethod()
java.lang.String	getMethodSignature() Method signature without "public void" prefix
java.lang.String	getPattern()
java.lang.String	getStartingWord()
java.lang.Object	getStepsInstance()
StepType	getStepType()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Stepdoc

public Stepdoc(StepCandidate candidate)

Method Detail

getStepType

public StepType getStepType()

getStartingWord

public java.lang.String getStartingWord()

getPattern

public java.lang.String getPattern()

getMethod

public java.lang.reflect.Method getMethod()

getStepsInstance

public java.lang.Object getStepsInstance()

getMethodSignature

public java.lang.String getMethodSignature()

Method signature without "public void" prefix

Returns:

The method signature in String format

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(Stepdoc that)

Specified by:

compareTo in interface java.lang.Comparable<Stepdoc>