org.jsondoc.core.pojo.flow

Class ApiFlowDoc

java.lang.Object

org.jsondoc.core.pojo.flow.ApiFlowDoc

All Implemented Interfaces:

Comparable<ApiFlowDoc>

public class ApiFlowDoc
extends Object
implements Comparable<ApiFlowDoc>

Field Summary

Fields

Modifier and Type	Field and Description
String	jsondocId

Constructor Summary

Constructors

Constructor and Description
ApiFlowDoc()

Method Summary

Modifier and Type	Method and Description
void	addMethod(ApiMethodDoc method)
void	addPrecondition(String precondition)
void	addStep(ApiFlowStepDoc apiFlowStepDoc)
static ApiFlowDoc	buildFromAnnotation(ApiFlow annotation, List<ApiMethodDoc> apiMethodDocs)
int	compareTo(ApiFlowDoc o)
String	getDescription()
String	getGroup()
List<ApiMethodDoc>	getMethods()
String	getName()
List<String>	getPreconditions()
List<ApiFlowStepDoc>	getSteps()
void	setDescription(String description)
void	setGroup(String group)
void	setMethods(List<ApiMethodDoc> methods)
void	setName(String name)
void	setPreconditions(List<String> preconditions)
void	setSteps(List<ApiFlowStepDoc> steps)

Methods inherited from class java.lang.Object

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

Field Detail

jsondocId

public final String jsondocId

Constructor Detail

ApiFlowDoc

public ApiFlowDoc()

Method Detail

buildFromAnnotation

public static ApiFlowDoc buildFromAnnotation(ApiFlow annotation,
                                             List<ApiMethodDoc> apiMethodDocs)

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getGroup

public String getGroup()

setGroup

public void setGroup(String group)

addStep

public void addStep(ApiFlowStepDoc apiFlowStepDoc)

getSteps

public List<ApiFlowStepDoc> getSteps()

setSteps

public void setSteps(List<ApiFlowStepDoc> steps)

getPreconditions

public List<String> getPreconditions()

setPreconditions

public void setPreconditions(List<String> preconditions)

addPrecondition

public void addPrecondition(String precondition)

getMethods

public List<ApiMethodDoc> getMethods()

setMethods

public void setMethods(List<ApiMethodDoc> methods)

addMethod

public void addMethod(ApiMethodDoc method)

compareTo

public int compareTo(ApiFlowDoc o)

Specified by:

compareTo in interface Comparable<ApiFlowDoc>