com.planet_ink.coffee_mud.core
Class CMFile

java.lang.Object
  com.planet_ink.coffee_mud.core.CMFile

public class CMFile
extends java.lang.Object

Nested Class Summary

static class	CMFile.CMVFSDir
static class	CMFile.CMVFSFile

Field Summary

static int	VFS_MASK_DIRECTORY
static int	VFS_MASK_MASKSAVABLE

Constructor Summary

CMFile(java.lang.String filename, MOB user, boolean pleaseLogErrors)

CMFile(java.lang.String filename, MOB user, boolean pleaseLogErrors, boolean forceAllow)

CMFile(java.lang.String currentPath, java.lang.String filename, MOB user, boolean pleaseLogErrors)

CMFile(java.lang.String currentPath, java.lang.String filename, MOB user, boolean pleaseLogErrors, boolean forceAllow)

Method Summary

java.lang.String	author()
boolean	canLocalEquiv()
boolean	canRead()
boolean	canVFSEquiv()
boolean	canWrite()
boolean	delete()
boolean	deleteLocal()
boolean	deleteVFS()
boolean	demandedLocal()
boolean	demandedVFS()
boolean	exists()
java.lang.String	getAbsolutePath()
java.lang.String	getCanonicalPath()
static CMFile[]	getFileList(java.lang.String parse, MOB user, boolean recurse, boolean expandDirs)
static CMFile[]	getFileList(java.lang.String currentPath, java.lang.String filename, MOB user, boolean recurse, boolean expandDirs)
java.lang.String	getIOReadableLocalPathAndName()
java.lang.String	getLocalPathAndName()
java.lang.String	getName()
CMFile	getParent()
static CMFile.CMVFSDir	getVFSDirectory()
java.lang.String	getVFSPathAndName()
boolean	isDirectory()
boolean	isFile()
boolean	isLocalDirectory()
boolean	isLocalFile()
boolean	isVFSDirectory()
boolean	isVFSFile()
long	lastModified()
java.lang.String[]	list()
CMFile[]	listFiles()
boolean	mayDeleteIfDirectory()
boolean	mkdir()
boolean	mustOverwrite()
byte[]	raw()
boolean	saveRaw(java.lang.Object data)
boolean	saveText(java.lang.Object data)
boolean	saveText(java.lang.Object data, boolean append)
java.lang.StringBuffer	text()
java.lang.StringBuffer	textUnformatted()
java.lang.StringBuffer	textVersion(byte[] bytes)
static java.lang.String	vfsifyFilename(java.lang.String filename)

Methods inherited from class java.lang.Object

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

Field Detail

VFS_MASK_MASKSAVABLE

public static final int VFS_MASK_MASKSAVABLE

See Also:

Constant Field Values

VFS_MASK_DIRECTORY

public static final int VFS_MASK_DIRECTORY

See Also:

Constant Field Values

Constructor Detail

CMFile

public CMFile(java.lang.String filename,
              MOB user,
              boolean pleaseLogErrors)

CMFile

public CMFile(java.lang.String filename,
              MOB user,
              boolean pleaseLogErrors,
              boolean forceAllow)

CMFile

public CMFile(java.lang.String currentPath,
              java.lang.String filename,
              MOB user,
              boolean pleaseLogErrors)

CMFile

public CMFile(java.lang.String currentPath,
              java.lang.String filename,
              MOB user,
              boolean pleaseLogErrors,
              boolean forceAllow)

Method Detail

getParent

public final CMFile getParent()

mustOverwrite

public final boolean mustOverwrite()

canRead

public final boolean canRead()

canWrite

public final boolean canWrite()

demandedVFS

public final boolean demandedVFS()

demandedLocal

public final boolean demandedLocal()

isDirectory

public final boolean isDirectory()

exists

public final boolean exists()

isFile

public final boolean isFile()

lastModified

public final long lastModified()

author

public final java.lang.String author()

isLocalFile

public final boolean isLocalFile()

isVFSFile

public final boolean isVFSFile()

canVFSEquiv

public final boolean canVFSEquiv()

canLocalEquiv

public final boolean canLocalEquiv()

getName

public final java.lang.String getName()

getAbsolutePath

public final java.lang.String getAbsolutePath()

getCanonicalPath

public final java.lang.String getCanonicalPath()

getLocalPathAndName

public final java.lang.String getLocalPathAndName()

getIOReadableLocalPathAndName

public final java.lang.String getIOReadableLocalPathAndName()

getVFSPathAndName

public final java.lang.String getVFSPathAndName()

mayDeleteIfDirectory

public final boolean mayDeleteIfDirectory()

deleteLocal

public final boolean deleteLocal()

deleteVFS

public final boolean deleteVFS()

delete

public final boolean delete()

text

public final java.lang.StringBuffer text()

textUnformatted

public final java.lang.StringBuffer textUnformatted()

raw

public final byte[] raw()

textVersion

public final java.lang.StringBuffer textVersion(byte[] bytes)

saveRaw

public final boolean saveRaw(java.lang.Object data)

saveText

public final boolean saveText(java.lang.Object data)

saveText

public final boolean saveText(java.lang.Object data,
                              boolean append)

mkdir

public final boolean mkdir()

list

public final java.lang.String[] list()

isVFSDirectory

public final boolean isVFSDirectory()

isLocalDirectory

public final boolean isLocalDirectory()

listFiles

public final CMFile[] listFiles()

getVFSDirectory

public static final CMFile.CMVFSDir getVFSDirectory()

vfsifyFilename

public static final java.lang.String vfsifyFilename(java.lang.String filename)

getFileList

public static final CMFile[] getFileList(java.lang.String currentPath,
                                         java.lang.String filename,
                                         MOB user,
                                         boolean recurse,
                                         boolean expandDirs)

getFileList

public static final CMFile[] getFileList(java.lang.String parse,
                                         MOB user,
                                         boolean recurse,
                                         boolean expandDirs)