Package org.apache.wicket.util.file

Class FileCleaner

  • All Implemented Interfaces:
    IFileCleaner
    public class FileCleaner
extends java.lang.Object
implements IFileCleaner
    Default implementation of IFileCleaner that uses Apache commons-io FileCleaningTracker to track and clean the temporary created files.

    Note: this implementation starts a daemon thread to do the actual work, so it may not be used in some environments like Google AppEngine.

    • Constructor Summary

      Constructors 
      Constructor Description
      FileCleaner()
      Construct.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void destroy()
      Call this method to stop the cleaner and to free all allocated resources by it
      void track​(java.io.File file, java.lang.Object marker)
      Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.
      void track​(java.io.File file, java.lang.Object marker, org.apache.commons.io.FileDeleteStrategy deleteStrategy)
      Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FileCleaner

        public FileCleaner()
        Construct.

    • Method Detail

      • track

        public void track​(java.io.File file,
                  java.lang.Object marker)
        Description copied from interface: IFileCleaner
        Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.
        Specified by:
        track in interface IFileCleaner
        Parameters:
        file - the file to be tracked, not null
        marker - the marker object used to track the file, not null

      • track

        public void track​(java.io.File file,
                  java.lang.Object marker,
                  org.apache.commons.io.FileDeleteStrategy deleteStrategy)
        Description copied from interface: IFileCleaner
        Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.
        Specified by:
        track in interface IFileCleaner
        Parameters:
        file - the file to be tracked, not null
        marker - the marker object used to track the file, not null
        deleteStrategy - the strategy that actually deletes the file. E.g. to delete a non-empty folder the strategy should delete all children first

      • destroy

        public void destroy()
        Description copied from interface: IFileCleaner
        Call this method to stop the cleaner and to free all allocated resources by it
        Specified by:
        destroy in interface IFileCleaner