PlanParser (Step 3.15.0 API)

java.lang.Object
- step.plans.nl.parser.PlanParser

```
public class PlanParser
extends Object
```
A parser for plans in plain-text format

Field Summary

Fields
Modifier and Type Field Description

protected ch.exense.commons.app.Configuration configuration

protected boolean wrapInTestcase

Constructor Summary

Constructors
Constructor Description

PlanParser()

PlanParser(ch.exense.commons.app.Configuration configuration)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isWrapInTestcase()`
`Plan`	`parse(InputStream inputStream)`	Parses a `Plan` in plain-text format from a stream
`protected Plan`	`parse(Reader contentReader)`
`Plan`	`parse(String content)`	Parses a `Plan` in plain-text format
`void`	`setWrapInTestcase(boolean wrapInTestcase)`

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

Field Detail

wrapInTestcase
```
protected boolean wrapInTestcase
```

configuration

protected ch.exense.commons.app.Configuration configuration

Constructor Detail

PlanParser
```
public PlanParser()
```

PlanParser

public PlanParser(ch.exense.commons.app.Configuration configuration)

Method Detail
- isWrapInTestcase
```
public boolean isWrapInTestcase()
```
- setWrapInTestcase
```
public void setWrapInTestcase(boolean wrapInTestcase)
```
- parse
```
public Plan parse(String content)
           throws StepsParser.ParsingException
```
  Parses a Plan in plain-text format
  
  Parameters:
  
  content - the plan in plain-text
  
  Returns:
  
  the parsed Plan
  
  Throws:
  
  StepsParser.ParsingException - if a parsing error occurs
- parse
```
public Plan parse(InputStream inputStream)
           throws StepsParser.ParsingException
```
  Parses a Plan in plain-text format from a stream
  
  Parameters:
  
  inputStream - the InputStream to be read
  
  Returns:
  
  the parsed Plan
  
  Throws:
  
  StepsParser.ParsingException - if a parsing error occurs
- parse
```
protected Plan parse(Reader contentReader)
              throws StepsParser.ParsingException
```
  Throws:
  
  StepsParser.ParsingException