|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface GeneratedFile
Provides information on a file generated by a text template.
This interface is not intended to be implemented by clients.
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 |
|---|
File getFile()
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.
EvaluationConfiguration.getEvaluationDirectory()String getEncoding()
null if encoded with platform default.List<ProtectedSection> getProtectedSections()
ProtectedSection elements.ProtectedSectionGeneratedFileStatus getStatus()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||