Package com.planet_ink.coffee_mud.core

Class CMFile.CMFileManager

java.lang.Object

com.planet_ink.coffee_mud.core.CMFile.CMFileManager

All Implemented Interfaces:

com.planet_ink.coffee_web.interfaces.FileManager

Enclosing class:

CMFile

public static class CMFile.CMFileManager
extends java.lang.Object
implements com.planet_ink.coffee_web.interfaces.FileManager

FileManager handler for CMFile, used by WebServer

Constructor Summary

Constructors

Constructor	Description
CMFileManager()

Method Summary

Modifier and Type	Method	Description
boolean	allowedToReadData(java.io.File file)	Returns true if the file exists and is readable and meets any other criteria the manager desires before deciding whether to allow reading.
java.io.File	createFileFromPath(java.io.File parent, java.lang.String localPath)	Create a file object from the given local path
java.io.File	createFileFromPath(java.lang.String localPath)	Create a file object from the given local path
char	getFileSeparator()	Return the appropriate file separator for this fs
java.io.InputStream	getFileStream(java.io.File file)	Return a readable input stream of the given files data
java.io.RandomAccessFile	getRandomAccessFile(java.io.File file)	Return a readable input stream of the given files data
byte[]	readFile(java.io.File file)	Read the data out out of the given file
boolean	supportsRandomAccess(java.io.File file)	Returns whether the given file can be randomly accessed

Methods inherited from class java.lang.Object

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

Constructor Detail

CMFileManager

public CMFileManager()

Method Detail

getFileSeparator

public char getFileSeparator()

Description copied from interface: com.planet_ink.coffee_web.interfaces.FileManager

Return the appropriate file separator for this fs

Specified by:

getFileSeparator in interface com.planet_ink.coffee_web.interfaces.FileManager

Returns:

the file separator string

createFileFromPath

public java.io.File createFileFromPath(java.lang.String localPath)

Description copied from interface: com.planet_ink.coffee_web.interfaces.FileManager

Create a file object from the given local path

Specified by:

createFileFromPath in interface com.planet_ink.coffee_web.interfaces.FileManager

Parameters:

localPath - the path c:\dljl\sdf\ format.

Returns:

a local File object

createFileFromPath

public java.io.File createFileFromPath(java.io.File parent,
                                       java.lang.String localPath)

Description copied from interface: com.planet_ink.coffee_web.interfaces.FileManager

Create a file object from the given local path

Specified by:

createFileFromPath in interface com.planet_ink.coffee_web.interfaces.FileManager

Parameters:

parent - the parent path c:\dljl\sdf\ format.

localPath - the path c:\dljl\sdf\ format.

Returns:

a local File object

readFile

public byte[] readFile(java.io.File file)
                throws java.io.IOException,
                       java.io.FileNotFoundException

Description copied from interface: com.planet_ink.coffee_web.interfaces.FileManager

Read the data out out of the given file

Specified by:

readFile in interface com.planet_ink.coffee_web.interfaces.FileManager

Parameters:

file - the file to read

Returns:

all the byte data from the file

Throws:

java.io.IOException - a read error

java.io.FileNotFoundException - the file was not found

getFileStream

public java.io.InputStream getFileStream(java.io.File file)
                                  throws java.io.IOException,
                                         java.io.FileNotFoundException

Description copied from interface: com.planet_ink.coffee_web.interfaces.FileManager

Return a readable input stream of the given files data

Specified by:

getFileStream in interface com.planet_ink.coffee_web.interfaces.FileManager

Parameters:

file - the file to read

Returns:

an open input stream for reading.

Throws:

java.io.IOException - a read error

java.io.FileNotFoundException - the file was not found

getRandomAccessFile

public java.io.RandomAccessFile getRandomAccessFile(java.io.File file)
                                             throws java.io.IOException,
                                                    java.io.FileNotFoundException

Description copied from interface: com.planet_ink.coffee_web.interfaces.FileManager

Return a readable input stream of the given files data

Specified by:

getRandomAccessFile in interface com.planet_ink.coffee_web.interfaces.FileManager

Parameters:

file - the file to read

Returns:

an open input stream for reading.

Throws:

java.io.IOException - a read error

java.io.FileNotFoundException - the file was not found

supportsRandomAccess

public boolean supportsRandomAccess(java.io.File file)

Description copied from interface: com.planet_ink.coffee_web.interfaces.FileManager

Returns whether the given file can be randomly accessed

Specified by:

supportsRandomAccess in interface com.planet_ink.coffee_web.interfaces.FileManager

Parameters:

file - the filemanager file to check for random access support.

Returns:

true if it can, or false otherwise

allowedToReadData

public boolean allowedToReadData(java.io.File file)

Description copied from interface: com.planet_ink.coffee_web.interfaces.FileManager

Returns true if the file exists and is readable and meets any other criteria the manager desires before deciding whether to allow reading.

Specified by:

allowedToReadData in interface com.planet_ink.coffee_web.interfaces.FileManager

Parameters:

file - the file from this manager to check

Returns:

true to proceed with reading, or false otherwise