com.sodius.mdw.core.eval
Interface ProtectedSection


public interface ProtectedSection

Describes a protected section in a text template output. A protected section delimits a region in a file that can contain end-user manual code and that the generator must never overwrite. The protected region allow end-users to insert manual code in the generated output.

A protected section is delimited by a start and an end tag. These tags can be any arbitrary (language specific) strings, including multiline strings (with '\n' characters). A start delimiter must be unique in the scope of the generated file.

This interface is not intended to be implemented by clients.

See Also:
GeneratedCode.getProtectedSections()

Method Summary
 String getEndTag()
          Return the end delimiter of the protected section.
 String getStartTag()
          Return the start delimiter of the protected section.
 

Method Detail

getStartTag

String getStartTag()
Return the start delimiter of the protected section. This start delimiter must be unique in the scope of the generated file.

Returns:
the start delimiter.

getEndTag

String getEndTag()
Return the end delimiter of the protected section.

Returns:
the end delimiter.