Package org.eclipse.epsilon.egl

Class EglFileGeneratingTemplate

java.lang.Object

org.eclipse.epsilon.egl.EglTemplate

org.eclipse.epsilon.egl.EglPersistentTemplate

org.eclipse.epsilon.egl.EglFileGeneratingTemplate

public class EglFileGeneratingTemplate
extends EglPersistentTemplate

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EglFileGeneratingTemplate.OutputMode

Field Summary

Fields inherited from class org.eclipse.epsilon.egl.EglPersistentTemplate

outputRoot, outputRootPath

Fields inherited from class org.eclipse.epsilon.egl.EglTemplate

listeners, module, name, template

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EglFileGeneratingTemplate(URI path, IEglContext context, URI outputRoot)
	EglFileGeneratingTemplate(EglTemplateSpecification spec, IEglContext context, URI outputRoot)
	EglFileGeneratingTemplate(EglTemplateSpecification spec, IEglContext context, URI outputRoot, String outputRootPath)

Method Summary

Modifier and Type	Method	Description
protected void	addProtectedRegionWarning(ProtectedRegionWarning warning)
File	append(String path)
protected void	doGenerate(File target, String targetName, boolean overwrite, boolean merge)	Store result of processing template in the given file.
OutputFile	getCurrentOutputFile()
String	getExistingContents()
String	getNewContents()
EglFileGeneratingTemplate.OutputMode	getOutputMode()
String	getPositiveMessage()
File	getTarget()
String	getTargetName()
protected boolean	isOverwriteUnchangedFiles()
File	patch(String path)
protected void	prepareNewContents()
void	setCurrentOutputFile(OutputFile currentOutputFile)
void	setExistingContents(String existingContents)
void	setNewContents(String newContents)
void	setOutputMode(EglFileGeneratingTemplate.OutputMode outputMode)
void	setPositiveMessage(String positiveMessage)
void	setTarget(File target)
void	setTargetName(String targetName)
protected void	write()
protected File	write(String path, EglFileGeneratingTemplate.OutputMode outputMode)
protected void	writeNewContentsIfDifferentFromExistingContents()

Methods inherited from class org.eclipse.epsilon.egl.EglPersistentTemplate

addMessage, generate, generate, name, resolveFile, store, store

Methods inherited from class org.eclipse.epsilon.egl.EglTemplate

getContents, getDeclaredModelDefinitions, getDeclaredOperations, getFormatter, getImports, getIncrementalitySettings, getModelDefinitions, getModule, getName, getOperations, getParseProblems, getTemplate, isProcessed, merge, populate, printWarning, process, reset, setFormatter, setFormatters, setFormatters, setIncrementalitySettings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EglFileGeneratingTemplate

protected EglFileGeneratingTemplate(URI path,
 IEglContext context,
 URI outputRoot)
                             throws Exception

Throws:

Exception

EglFileGeneratingTemplate

public EglFileGeneratingTemplate(EglTemplateSpecification spec,
 IEglContext context,
 URI outputRoot,
 String outputRootPath)
                          throws Exception

Throws:

Exception

EglFileGeneratingTemplate

public EglFileGeneratingTemplate(EglTemplateSpecification spec,
 IEglContext context,
 URI outputRoot)
                          throws Exception

Parameters:

spec -

context -

outputRoot -

Throws:

Exception

Since:

1.6

Method Details

append

public File append(String path)
            throws EglRuntimeException

Throws:

EglRuntimeException

patch

public File patch(String path)
           throws EglRuntimeException

Throws:

EglRuntimeException

write

protected File write(String path,
 EglFileGeneratingTemplate.OutputMode outputMode)
              throws EglRuntimeException

Throws:

EglRuntimeException

doGenerate

protected void doGenerate(File target,
 String targetName,
 boolean overwrite,
 boolean merge)
                   throws EglRuntimeException

Description copied from class: EglPersistentTemplate

Store result of processing template in the given file. Subclasses should override to implement the specific semantics of 'storing' to a file. The result of processing the template will be available from EglTemplate.contents.

Specified by:

doGenerate in class EglPersistentTemplate

Throws:

EglRuntimeException

prepareNewContents

protected void prepareNewContents()
                           throws EglRuntimeException

Throws:

EglRuntimeException

writeNewContentsIfDifferentFromExistingContents

protected void writeNewContentsIfDifferentFromExistingContents()
                                                        throws URISyntaxException,
IOException

Throws:

URISyntaxException

IOException

isOverwriteUnchangedFiles

protected boolean isOverwriteUnchangedFiles()

write

protected void write()
              throws IOException,
URISyntaxException

Throws:

IOException

URISyntaxException

addProtectedRegionWarning

protected void addProtectedRegionWarning(ProtectedRegionWarning warning)

Overrides:

addProtectedRegionWarning in class EglTemplate

getTarget

public File getTarget()

setTarget

public void setTarget(File target)

getTargetName

public String getTargetName()

setTargetName

public void setTargetName(String targetName)

getCurrentOutputFile

public OutputFile getCurrentOutputFile()

setCurrentOutputFile

public void setCurrentOutputFile(OutputFile currentOutputFile)

getExistingContents

public String getExistingContents()

setExistingContents

public void setExistingContents(String existingContents)

getNewContents

public String getNewContents()

setNewContents

public void setNewContents(String newContents)

getPositiveMessage

public String getPositiveMessage()

setPositiveMessage

public void setPositiveMessage(String positiveMessage)

getOutputMode

public EglFileGeneratingTemplate.OutputMode getOutputMode()

setOutputMode

public void setOutputMode(EglFileGeneratingTemplate.OutputMode outputMode)