ListingDocument (cowem-plugin 1.19.0 API)

java.lang.Object
- edu.odu.cs.cowem.documents.ListingDocument

All Implemented Interfaces:

Document
```
public class ListingDocument
extends java.lang.Object
implements Document
```
A Document consisting of source code or uninterpreted data.

Constructor Summary

Constructors
Constructor	Description
`ListingDocument(java.io.File input, WebsiteProject project0, java.util.Properties properties0)`	Create a document from the given file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`transform(java.lang.String format)`	Transform this document into a string suitable for writing into an HTML file.

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

- Constructor Detail
  - ListingDocument
```
public ListingDocument(java.io.File input,
                       WebsiteProject project0,
                       java.util.Properties properties0)
```
    Create a document from the given file.
    
    Parameters:
    
    input - listing document source file
    
    project0 - website project contest.
    
    properties0 - Properties to be used in processing this document.
- Method Detail
  - transform
```
public final java.lang.String transform(java.lang.String format)
```
    Transform this document into a string suitable for writing into an HTML file.
    
    Specified by:
    
    transform in interface Document
    
    Parameters:
    
    format - Specifies a style/format for the generated HTML.
    
    Returns:
    
    String containing HTML of page for web site.