Document (com.credibledoc:substitution-reporting 1.0.50 API)

java.lang.Object
- com.credibledoc.substitution.reporting.report.document.Document

All Implemented Interfaces:

Printable, ReportDocument
```
public class Document
extends Object
implements ReportDocument
```
Contains a state of a single generated report document.

Author:

Kyrylo Semenko

Field Summary

Fields
Modifier and Type	Field and Description
`private List<String>`	`cacheLines` Transformed lines prepared to print out, for example PlantUml lines
`private boolean`	`checkAllLineProcessors` If the `Printable.checkAllLineProcessors()` is 'false', only the first applicable `LineProcessor` will be processed.
`private int`	`fileNumber` One report may have more files, for example application.0.log.expanded, application.1.log.expanded and so on.
`private Consumer<ReportDocument>`	`footerMethod` This method will be called as the last method before closing of a `Document` file
`private Set<NodeFile>`	`nodeFiles` Contains `NodeFile`s this `Document` obtains data from.
`private PrintWriter`	`printWriter` `Writer` of the report document
`private Report`	`report` The `Report` this `Document` belongs to
`private Class<? extends ReportDocumentType>`	`reportDocumentType` A `ReportDocumentType` of this `Document`

Constructor Summary

Constructors
Constructor and Description

Document()

Constructors
Constructor and Description
`Document()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkAllLineProcessors()`
`List<String>`	`getCacheLines()`
`Consumer<ReportDocument>`	`getFooterMethod()`
`Set<NodeFile>`	`getNodeFiles()`
`PrintWriter`	`getPrintWriter()`
`Report`	`getReport()`
`Class<? extends ReportDocumentType>`	`getReportDocumentType()`
`void`	`setCacheLines(List<String> cacheLines)`
`void`	`setCheckAllLineProcessors(boolean checkAllLineProcessors)`
`void`	`setFooterMethod(Consumer<ReportDocument> footerMethod)`
`void`	`setNodeFiles(Set<NodeFile> nodeFiles)`
`void`	`setPrintWriter(PrintWriter printWriter)`
`void`	`setReport(Report report)`
`void`	`setReportDocumentType(Class<? extends ReportDocumentType> reportDocumentType)`
`String`	`toString()`

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

- Field Detail
  - printWriter
```
private PrintWriter printWriter
```
    Writer of the report document
  - fileNumber
```
private int fileNumber
```
    One report may have more files, for example application.0.log.expanded, application.1.log.expanded and so on.
  - footerMethod
```
private Consumer<ReportDocument> footerMethod
```
    This method will be called as the last method before closing of a Document file
  - cacheLines
```
private List<String> cacheLines
```
    Transformed lines prepared to print out, for example PlantUml lines
  - reportDocumentType
```
private Class<? extends ReportDocumentType> reportDocumentType
```
    A ReportDocumentType of this Document
  - nodeFiles
```
private Set<NodeFile> nodeFiles
```
    Contains NodeFiles this Document obtains data from.
  - report
```
private Report report
```
    The Report this Document belongs to
  - checkAllLineProcessors
```
private boolean checkAllLineProcessors
```
    If the Printable.checkAllLineProcessors() is 'false', only the first applicable LineProcessor will be processed. Else all applicable line processors will be processed.
- Constructor Detail
  - Document
```
public Document()
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getPrintWriter
```
public PrintWriter getPrintWriter()
```
    Specified by:
    
    getPrintWriter in interface Printable
  - setPrintWriter
```
public void setPrintWriter(PrintWriter printWriter)
```
    Parameters:
    
    printWriter - see the printWriter field
  - getFooterMethod
```
public Consumer<ReportDocument> getFooterMethod()
```
    Specified by:
    
    getFooterMethod in interface ReportDocument
    
    Returns:
    
    The footerMethod field
  - setFooterMethod
```
public void setFooterMethod(Consumer<ReportDocument> footerMethod)
```
    Parameters:
    
    footerMethod - see the footerMethod field
  - getCacheLines
```
public List<String> getCacheLines()
```
    Specified by:
    
    getCacheLines in interface Printable
  - setCacheLines
```
public void setCacheLines(List<String> cacheLines)
```
    Parameters:
    
    cacheLines - see the cacheLines field
  - getReportDocumentType
```
public Class<? extends ReportDocumentType> getReportDocumentType()
```
    Specified by:
    
    getReportDocumentType in interface ReportDocument
    
    Returns:
    
    The reportDocumentType field value.
  - setReportDocumentType
```
public void setReportDocumentType(Class<? extends ReportDocumentType> reportDocumentType)
```
    Parameters:
    
    reportDocumentType - see the reportDocumentType field description.
  - getNodeFiles
```
public Set<NodeFile> getNodeFiles()
```
    Specified by:
    
    getNodeFiles in interface ReportDocument
    
    Returns:
    
    The nodeFiles field value.
  - setNodeFiles
```
public void setNodeFiles(Set<NodeFile> nodeFiles)
```
    Parameters:
    
    nodeFiles - see the nodeFiles field
  - getReport
```
public Report getReport()
```
    Specified by:
    
    getReport in interface ReportDocument
    
    Returns:
    
    The report field value.
  - setReport
```
public void setReport(Report report)
```
    Specified by:
    
    setReport in interface ReportDocument
    
    Parameters:
    
    report - see the report field description.
  - checkAllLineProcessors
```
public boolean checkAllLineProcessors()
```
    Specified by:
    
    checkAllLineProcessors in interface Printable
    
    Returns:
    
    The checkAllLineProcessors field value.
  - setCheckAllLineProcessors
```
public void setCheckAllLineProcessors(boolean checkAllLineProcessors)
```
    Parameters:
    
    checkAllLineProcessors - see the checkAllLineProcessors field description.

Class Document

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

printWriter

fileNumber

footerMethod

cacheLines

reportDocumentType

nodeFiles

report

checkAllLineProcessors

Constructor Detail

Document

Method Detail

toString

getPrintWriter

setPrintWriter

getFooterMethod

setFooterMethod

getCacheLines

setCacheLines

getReportDocumentType

setReportDocumentType

getNodeFiles

setNodeFiles

getReport

setReport

checkAllLineProcessors

setCheckAllLineProcessors