PlanParser (Step 3.17.0 API)

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

public class PlanParser
extends java.lang.Object

A parser for plans in plain-text format

Field Summary

Fields
Modifier and Type Field Description

protected ch.exense.commons.app.Configuration configuration

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
`Plan`	`parse(java.io.InputStream inputStream, RootArtefactType rootType)`	Parses a `Plan` in plain text format from a stream
`protected Plan`	`parse(java.io.Reader contentReader, RootArtefactType rootType)`
`Plan`	`parse(java.lang.String content, RootArtefactType rootType)`	Parses a `Plan` in plain text format

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

Field Detail

configuration

protected ch.exense.commons.app.Configuration configuration

Constructor Detail

PlanParser
```
public PlanParser()
```

PlanParser

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

Method Detail
- parse
```
public Plan parse(java.lang.String content,
                  RootArtefactType rootType)
           throws StepsParser.ParsingException
```
  Parses a Plan in plain text format
  
  Parameters:
  
  content - the plan in plain text
  
  rootType - the type of the root artefact to use. May be null if wrapping is unwanted.
  
  Returns:
  
  the parsed Plan
  
  Throws:
  
  StepsParser.ParsingException - if a parsing error occurs
- parse
```
public Plan parse(java.io.InputStream inputStream,
                  RootArtefactType rootType)
           throws StepsParser.ParsingException
```
  Parses a Plan in plain text format from a stream
  
  Parameters:
  
  inputStream - the InputStream to be read
  
  rootType - the type of the root artefact to use. May be null if wrapping is unwanted.
  
  Returns:
  
  the parsed Plan
  
  Throws:
  
  StepsParser.ParsingException - if a parsing error occurs
- parse
```
protected Plan parse(java.io.Reader contentReader,
                     RootArtefactType rootType)
              throws StepsParser.ParsingException
```
  Throws:
  
  StepsParser.ParsingException