com.sodius.mdw.core.eval.report
Interface GeneratedFile


public interface GeneratedFile

Provides information on a file generated by a text template.

This interface is not intended to be implemented by clients.

See Also:
Report.getGeneratedFiles()

Method Summary
 String getEncoding()
          Returns the encoding used to write the generated file.
 File getFile()
          Returns the absolute path of the generated file.
 List<ProtectedSection> getProtectedSections()
          Returns the list of protected sections, which delimit regions in a file that can contain end-user manual code and that the generator must never overwrite.
 GeneratedFileStatus getStatus()
          Returns the status of the generated file, which describes the state of the file contents.
 

Method Detail

getFile

File getFile()
Returns the absolute path of the generated file.

A text template may output a relative path, which is then resolved against a default evaluation directory. The returned file is the absolute location of this resolved path.

Returns:
the absolute file.
See Also:
EvaluationConfiguration.getEvaluationDirectory()

getEncoding

String getEncoding()
Returns the encoding used to write the generated file.

Returns:
the generated file encoding, null if encoded with platform default.

getProtectedSections

List<ProtectedSection> getProtectedSections()
Returns the list of protected sections, which delimit regions in a file that can contain end-user manual code and that the generator must never overwrite.

Returns:
an unmodifiable list of ProtectedSection elements.
See Also:
ProtectedSection

getStatus

GeneratedFileStatus getStatus()
Returns the status of the generated file, which describes the state of the file contents.

Returns:
the generated file status.