de.dv.sbu.filehandler.ftl
Class Overlay

java.lang.Object
  extended by de.dv.sbu.filehandler.ftl.Overlay

public class Overlay
extends java.lang.Object

An overlay specifies additional properties for a specific file filter. All defined (non null) properties will be used instead of the ones defined originally in the parent FtlFileHandler. A file filter must be set.

Author:
Daniel Vogtland

Constructor Summary
Overlay()
           
 
Method Summary
 java.lang.String getEncoding()
          Returns the charset to use - if defined.
 IFileFilter getFileFilter()
          Returns the file filter used for matching.
 java.lang.String getForcedSuffix()
          Returns the overlay forced suffix - if defined.
 java.lang.String getLayoutTemplate()
          Returns the layout template path.
 java.util.Locale getLocale()
          Returns the overlay locale - if defined.
 ISourceParser getSourceParser()
          Returns the overlay source parser - if defined.
 void setEncoding(java.lang.String encoding)
          Sets or removes the overlay charset.
 void setFileFilter(IFileFilter fileFilter)
          Sets the file filter.
 void setForcedSuffix(java.lang.String forcedSuffix)
          Sets or removes the overlay forced suffix.
 void setLayoutTemplate(java.lang.String layoutTemplate)
          Sets or removes the overlay template path.
 void setLocale(java.util.Locale locale)
          Sets or removes the overlay locale.
 void setSourceParser(ISourceParser sourceParser)
          Sets or removes the overlay source parser.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Overlay

public Overlay()
Method Detail

getFileFilter

public IFileFilter getFileFilter()
Returns the file filter used for matching.

Returns:
The used file filter.

setFileFilter

public void setFileFilter(IFileFilter fileFilter)
                   throws java.lang.NullPointerException
Sets the file filter.

Parameters:
fileFilter - the filter to use.
Throws:
java.lang.NullPointerException - The argument is null.

getLayoutTemplate

public java.lang.String getLayoutTemplate()
Returns the layout template path. If defined.

Returns:
The layout template path or null.

setLayoutTemplate

public void setLayoutTemplate(java.lang.String layoutTemplate)
Sets or removes the overlay template path.

Parameters:
layoutTemplate - The path to set or null.

getEncoding

public java.lang.String getEncoding()
Returns the charset to use - if defined.

Returns:
the charset or null.

setEncoding

public void setEncoding(java.lang.String encoding)
Sets or removes the overlay charset.

Parameters:
encoding - The charset to set or null.

getLocale

public java.util.Locale getLocale()
Returns the overlay locale - if defined.

Returns:
the locale to use or null.

setLocale

public void setLocale(java.util.Locale locale)
Sets or removes the overlay locale.

Parameters:
locale - The locale to set or null.

getSourceParser

public ISourceParser getSourceParser()
Returns the overlay source parser - if defined.

Returns:
The source parser or null.

setSourceParser

public void setSourceParser(ISourceParser sourceParser)
Sets or removes the overlay source parser.

Parameters:
sourceParser - the source parser to use or null.

getForcedSuffix

public java.lang.String getForcedSuffix()
Returns the overlay forced suffix - if defined.

Returns:
The forced suffix or null.

setForcedSuffix

public void setForcedSuffix(java.lang.String forcedSuffix)
Sets or removes the overlay forced suffix.

Parameters:
forcedSuffix - The overlay forced suffix or null.