net.sf.javadocbuilder.templatesources.filesystem
Class FilesystemTemplate

java.lang.Object
  |
  +--net.sf.javadocbuilder.BaseTemplate
        |
        +--net.sf.javadocbuilder.templatesources.filesystem.FilesystemTemplate

All Implemented Interfaces:

ITemplate

public class FilesystemTemplate

extends BaseTemplate

Author:

mgriffa

Field Summary

private java.io.File	file
private static java.util.logging.Logger	log

Fields inherited from class net.sf.javadocbuilder.BaseTemplate

buffer, id, name, outputPattern

Constructor Summary

FilesystemTemplate(java.io.File file)

FilesystemTemplate(java.lang.String filename)

Method Summary

java.lang.String	getId() Gets a string that uniquely identifies the template within a source
java.lang.String	getName() Gets the name of the template.
private void	readFile()

Methods inherited from class net.sf.javadocbuilder.BaseTemplate

getBuffer, getOutputPattern, isDirty, setBuffer, setId, setName, setOutputPattern

Methods inherited from class java.lang.Object

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

Field Detail

file

private java.io.File file

log

private static java.util.logging.Logger log

Constructor Detail

FilesystemTemplate

public FilesystemTemplate(java.lang.String filename)
                   throws java.io.IOException

FilesystemTemplate

public FilesystemTemplate(java.io.File file)
                   throws java.io.FileNotFoundException,
                          java.io.IOException

Parameters:

file -

Method Detail

readFile

private void readFile()
               throws java.io.IOException

java.io.IOException

getName

public java.lang.String getName()

Description copied from interface: ITemplate

Gets the name of the template.

Specified by:

getName in interface ITemplate

Overrides:

getName in class BaseTemplate

Returns:

a String with the name of the template

getId

public java.lang.String getId()

Description copied from interface: ITemplate

Gets a string that uniquely identifies the template within a source

Specified by:

getId in interface ITemplate

Overrides:

getId in class BaseTemplate

Returns:

Returns the id.