nl.toolforge.karma.core.module.template
Class FileTemplate

java.lang.Object
  nl.toolforge.karma.core.module.template.FileTemplate

public class FileTemplate

extends java.lang.Object

Specifies the location of a template and the file where it should be copied to. These locations need to be absolute paths.

Author:

W.H. Schraal

Field Summary

(package private) static java.lang.String	SOURCE_IS_NULL
(package private) static java.lang.String	TARGET_IS_NULL

Constructor Summary

FileTemplate(java.io.File source, java.io.File target)
Create a FileTemplate object that specifies the source and target location of a template.

Method Summary

java.io.File	getSource() Retrieve the source location of the template.
java.io.File	getTarget() Retrieve the target location of the template.

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_IS_NULL

static final java.lang.String SOURCE_IS_NULL

See Also:

Constant Field Values

TARGET_IS_NULL

static final java.lang.String TARGET_IS_NULL

See Also:

Constant Field Values

Constructor Detail

FileTemplate

public FileTemplate(java.io.File source,
                    java.io.File target)

Create a FileTemplate object that specifies the source and target location of a template. This information can be used to copy a template to a target location.

Parameters:

source - Location of the template. May not be null.

target - Target location of the template, relative. May not be null.

Method Detail

getSource

public java.io.File getSource()

Retrieve the source location of the template.

Returns:

Non-null and existing File

getTarget

public java.io.File getTarget()

Retrieve the target location of the template.

Returns:

non-null, but not necessarily existing File.