org.bladerunnerjs.api.memoization

Class MemoizedFile

java.lang.Object

java.io.File

org.bladerunnerjs.api.memoization.MemoizedFile

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<java.io.File>

public class MemoizedFile
extends java.io.File
implements java.lang.Comparable<java.io.File>

Provides similar methods to File and wraps a File object. Several of the methods' return values are 'memoized' and only regenerated if properties on the underlying file on disk change. Changes are detected by using MemoizedValue and the FileModificationRegistry.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors

Constructor and Description
MemoizedFile(org.bladerunnerjs.model.engine.RootNode rootNode, java.lang.String file)

Method Summary

Modifier and Type	Method and Description
boolean	createNewFile()
boolean	delete()
java.util.List<MemoizedFile>	dirs()
boolean	exists()
MemoizedFile	file(java.lang.String childPath)
java.util.List<MemoizedFile>	files()
java.util.List<MemoizedFile>	filesAndDirs()
java.util.List<MemoizedFile>	filesAndDirs(org.apache.commons.io.filefilter.IOFileFilter fileFilter)
MemoizedFile	getAbsoluteFile()
java.lang.String	getAbsolutePath()
java.lang.String	getName()
MemoizedFile	getParentFile()
java.lang.String	getRelativePath(MemoizedFile childFile)
java.io.File	getUnderlyingFile()
void	incrementChildFileVersions()
void	incrementFileVersion()
boolean	isChildOf(MemoizedFile file)
boolean	isDirectory()
boolean	isEmpty()
boolean	isFile()
java.lang.Object	jsStyle()
java.lang.String[]	list()
java.lang.String[]	list(java.io.FilenameFilter filter)
MemoizedFile[]	listFiles()
MemoizedFile[]	listFiles(java.io.FileFilter filter)
MemoizedFile[]	listFiles(java.io.FilenameFilter filter)
boolean	mkdir()
boolean	mkdirs()
java.util.List<MemoizedFile>	nestedDirs()
java.util.List<MemoizedFile>	nestedFiles()
java.util.List<MemoizedFile>	nestedFilesAndDirs()
java.util.List<MemoizedFile>	nestedFilesAndDirs(org.apache.commons.io.filefilter.IOFileFilter fileFilter)
boolean	renameTo(java.io.File dest)
java.lang.String	requirePathName()

Methods inherited from class java.io.File

canExecute, canRead, canWrite, compareTo, createTempFile, createTempFile, deleteOnExit, equals, getCanonicalFile, getCanonicalPath, getFreeSpace, getParent, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isHidden, lastModified, length, listRoots, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toPath, toString, toURI, toURL

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

MemoizedFile

public MemoizedFile(org.bladerunnerjs.model.engine.RootNode rootNode,
                    java.lang.String file)

Method Detail

getName

public java.lang.String getName()

Overrides:

getName in class java.io.File

getAbsolutePath

public java.lang.String getAbsolutePath()

Overrides:

getAbsolutePath in class java.io.File

exists

public boolean exists()

Overrides:

exists in class java.io.File

isDirectory

public boolean isDirectory()

Overrides:

isDirectory in class java.io.File

isFile

public boolean isFile()

Overrides:

isFile in class java.io.File

filesAndDirs

public java.util.List<MemoizedFile> filesAndDirs()

getAbsoluteFile

public MemoizedFile getAbsoluteFile()

Overrides:

getAbsoluteFile in class java.io.File

getParentFile

public MemoizedFile getParentFile()

Overrides:

getParentFile in class java.io.File

listFiles

public MemoizedFile[] listFiles(java.io.FileFilter filter)

Overrides:

listFiles in class java.io.File

listFiles

public MemoizedFile[] listFiles(java.io.FilenameFilter filter)

Overrides:

listFiles in class java.io.File

listFiles

public MemoizedFile[] listFiles()

Overrides:

listFiles in class java.io.File

list

public java.lang.String[] list(java.io.FilenameFilter filter)

Overrides:

list in class java.io.File

list

public java.lang.String[] list()

Overrides:

list in class java.io.File

filesAndDirs

public java.util.List<MemoizedFile> filesAndDirs(org.apache.commons.io.filefilter.IOFileFilter fileFilter)

files

public java.util.List<MemoizedFile> files()

dirs

public java.util.List<MemoizedFile> dirs()

nestedFilesAndDirs

public java.util.List<MemoizedFile> nestedFilesAndDirs()

nestedFilesAndDirs

public java.util.List<MemoizedFile> nestedFilesAndDirs(org.apache.commons.io.filefilter.IOFileFilter fileFilter)

nestedFiles

public java.util.List<MemoizedFile> nestedFiles()

nestedDirs

public java.util.List<MemoizedFile> nestedDirs()

file

public MemoizedFile file(java.lang.String childPath)

getUnderlyingFile

public java.io.File getUnderlyingFile()

getRelativePath

public java.lang.String getRelativePath(MemoizedFile childFile)

incrementFileVersion

public void incrementFileVersion()

incrementChildFileVersions

public void incrementChildFileVersions()

mkdir

public boolean mkdir()

Overrides:

mkdir in class java.io.File

mkdirs

public boolean mkdirs()

Overrides:

mkdirs in class java.io.File

createNewFile

public boolean createNewFile()
                      throws java.io.IOException

Overrides:

createNewFile in class java.io.File

Throws:

java.io.IOException

delete

public boolean delete()

Overrides:

delete in class java.io.File

renameTo

public boolean renameTo(java.io.File dest)

Overrides:

renameTo in class java.io.File

isEmpty

public boolean isEmpty()

jsStyle

public java.lang.Object jsStyle()

isChildOf

public boolean isChildOf(MemoizedFile file)

requirePathName

public java.lang.String requirePathName()