nu.staldal.lagoon.core
Interface FileTarget

All Superinterfaces:
Target

public interface FileTarget
extends Target

Defines operations a Producer can do on a File target.


Method Summary
 boolean isWildcard()
          Determine if this file target is a wildcard.
 OutputHandler newAsyncTarget(java.lang.String filename, boolean prependFilename)
          Open a new target file, without closing the current one.
 org.xml.sax.ContentHandler newAsyncTargetWithOutput(java.lang.String filename, boolean prependFilename, java.lang.String output)
          Open a new target file, without closing the current one.
 void newTarget(java.lang.String filename, boolean prependFilename)
          Open a new target file, and close the current one.
 
Methods inherited from interface nu.staldal.lagoon.core.Target
getCurrentTargetURL
 

Method Detail

newTarget

void newTarget(java.lang.String filename,
               boolean prependFilename)
Open a new target file, and close the current one. Used for splitting.

Parameters:
filename - filename to use, must not start with '/'
prependFilename - prepend the name of the current main file and an '_' to the new file name.

newAsyncTarget

OutputHandler newAsyncTarget(java.lang.String filename,
                             boolean prependFilename)
                             throws java.io.IOException
Open a new target file, without closing the current one.

Parameters:
filename - filename to use, may start with '/'
prependFilename - prepend the name of the current main file and an '_' to the new file name (has no effect if filename starts with '/').
Returns:
an OutputHandler to send a byte stream to
Throws:
java.io.IOException

newAsyncTargetWithOutput

org.xml.sax.ContentHandler newAsyncTargetWithOutput(java.lang.String filename,
                                                    boolean prependFilename,
                                                    java.lang.String output)
                                                    throws java.io.IOException,
                                                           org.xml.sax.SAXException
Open a new target file, without closing the current one. Uses an specification from the Sitemap.

Parameters:
filename - filename to use, may start with '/'
prependFilename - prepend the name of the current main file and an '_' to the new file name (has no effect if filename starts with '/').
output - an specification from the Sitemap.
Returns:
an SAX ContentHandler to send an XML stream to
Throws:
java.io.IOException
org.xml.sax.SAXException

isWildcard

boolean isWildcard()
Determine if this file target is a wildcard.