Package hec.io

Class SimpleFile

java.lang.Object

java.io.File

hec.io.SimpleFile

All Implemented Interfaces:

HecFile, Serializable, Comparable<File>

public class SimpleFile
extends File
implements HecFile

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static boolean	_staticWriteToTmpDefault	Default value for write to a tmp file.
protected boolean	_writeToTmp	whether to write to a tmp file instead of the real file during writes
protected static final String	BAK_EXTENSION	extension used for backup files
protected static final String	TMP_EXTENSION	extension used for temp files

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors

Constructor	Description
SimpleFile(File parent, String child)
SimpleFile(String pathname)
SimpleFile(String parent, String child)

Method Summary

Modifier and Type	Method	Description
boolean	appendByteArray(byte[] byteArray)	Appends byteArray to the end of this file.
void	close()	Closes any open writers and flushes their data to disk.
protected void	copyFile(File src, File dest)	copies src to dest - does no checking of the files.
BufferedWriter	getAppendedBufferedWriter()	Get a BufferedWriter to append to the end of this file.
DataOutputStream	getAppendedDataOutputStream()	Get a DataOutputStream for appending to the end of this file.
BufferedReader	getBufferedReader()	Get a BufferedReader for this file.
BufferedWriter	getBufferedWriter()	Get a BufferedWriter to write to this file.
byte[]	getByteArray()	Get the byte[] representing this HecFile's data.
byte[]	getByteArray(boolean compress)	Return a byte[] containing the data from the File.
byte[]	getByteArray(long off, int len)	Get the byte[] representing this HecFile's data starting at offset for the length amount.
ByteArrayInputStream	getByteArrayInputStream()	Get a ByteArrayInputStream for this file.
ByteArrayOutputStream	getByteArrayOutputStream()	Get a ByteArrayOutputStream for this file.
long	getCheckSum()	Get the check sum for this file.
DataInputStream	getDataInputStream()	Get a DataInputStream for this file.
DataOutputStream	getDataOutputStream()	Get a DataOutputStream for writing to this file.
EndianInputStream	getEndianInputStream()	Get an EndianInputStream for this file.
EndianOutputStream	getEndianOutputStream()	Get an EndianOutputStream for this file.
ObjectInputStream	getObjectInputStream()	Get an ObjectInputStream for this file.
ObjectOutputStream	getObjectOutputStream()	Get an ObjectOutputStream for this file.
boolean	getUsingCompression()	return whether this HecFile is using Compression to read/write data to the RmiFile
boolean	isNetworked()	Get whether this HecFile represents a networked or local file.
boolean	lockFile(FileLock fLock)	Lock this file with fLock.
void	notify(String message)	Send message to all callback objects registered with this file.
boolean	save()	Save the contents of any writers that are currently in use.
boolean	setByteArray(byte[] byteArray)	Set this HecFile's data to byteArray starting at the beginning of the file
void	setUseCompression(boolean compress)	set whether this HecFile should use compression to read/write data to/from the RmiFile
static void	setWriteToTmpFile(boolean writeToTmp)
boolean	unlockFile(FileLock fLock)	Unlock this file with fLock.
void	writeBytes(long bytePos, byte[] bytes)
void	writeFloat(long bytePos, float f)	Write a float f to position bytePos in this HecFile.

Methods inherited from class java.io.File

canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, 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 hec.io.HecFile

canRead, canWrite, exists, getLineSeparator, getName, getPath, isDirectory, isFile, lastModified, length, mkdirs

Field Details

TMP_EXTENSION

protected static final String TMP_EXTENSION

extension used for temp files

See Also:

• Constant Field Values

BAK_EXTENSION

protected static final String BAK_EXTENSION

extension used for backup files

See Also:

• Constant Field Values

_staticWriteToTmpDefault

protected static boolean _staticWriteToTmpDefault

Default value for write to a tmp file.

_writeToTmp

protected boolean _writeToTmp

whether to write to a tmp file instead of the real file during writes

Constructor Details

SimpleFile

public SimpleFile(File parent,
 String child)

Parameters:

parent -

child -

SimpleFile

public SimpleFile(String parent,
 String child)

SimpleFile

public SimpleFile(String pathname)

Method Details

setWriteToTmpFile

public static void setWriteToTmpFile(boolean writeToTmp)

appendByteArray

public boolean appendByteArray(byte[] byteArray)

Description copied from interface: HecFile

Appends byteArray to the end of this file.

Specified by:

appendByteArray in interface HecFile

Parameters:

byteArray -

Returns:

See Also:

• HecFile.appendByteArray(byte[])

copyFile

protected void copyFile(File src,
 File dest)
                 throws IOException

copies src to dest - does no checking of the files.

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: HecFile

Closes any open writers and flushes their data to disk.

Specified by:

close in interface HecFile

Throws:

IOException

See Also:

• HecFile.close()

getAppendedBufferedWriter

public BufferedWriter getAppendedBufferedWriter()

Description copied from interface: HecFile

Get a BufferedWriter to append to the end of this file.

Specified by:

getAppendedBufferedWriter in interface HecFile

Returns:

See Also:

• HecFile.getAppendedBufferedWriter()

getAppendedDataOutputStream

public DataOutputStream getAppendedDataOutputStream()

Description copied from interface: HecFile

Get a DataOutputStream for appending to the end of this file.

Specified by:

getAppendedDataOutputStream in interface HecFile

Returns:

See Also:

• HecFile.getAppendedDataOutputStream()

getBufferedReader

public BufferedReader getBufferedReader()

Description copied from interface: HecFile

Get a BufferedReader for this file.

Specified by:

getBufferedReader in interface HecFile

Returns:

See Also:

• HecFile.getBufferedReader()

getBufferedWriter

public BufferedWriter getBufferedWriter()

Description copied from interface: HecFile

Get a BufferedWriter to write to this file.

Specified by:

getBufferedWriter in interface HecFile

Returns:

See Also:

• HecFile.getBufferedWriter()

getByteArray

public byte[] getByteArray()

Description copied from interface: HecFile

Get the byte[] representing this HecFile's data. This may or may not be the complete contents of the file.

Specified by:

getByteArray in interface HecFile

Returns:

See Also:

• HecFile.getByteArray()

getByteArray

public byte[] getByteArray(boolean compress)

Return a byte[] containing the data from the File.

Parameters:

compress - flag indicating whether to compress the byte[] being returned

getByteArray

public byte[] getByteArray(long off,
 int len)

Description copied from interface: HecFile

Get the byte[] representing this HecFile's data starting at offset for the length amount. The may or may not be the complete contents of the file.

Specified by:

getByteArray in interface HecFile

Parameters:

off -

len -

Returns:

See Also:

• HecFile.getByteArray(long, int)

getByteArrayInputStream

public ByteArrayInputStream getByteArrayInputStream()

Description copied from interface: HecFile

Get a ByteArrayInputStream for this file.

Specified by:

getByteArrayInputStream in interface HecFile

Returns:

See Also:

• HecFile.getByteArrayInputStream()

getByteArrayOutputStream

public ByteArrayOutputStream getByteArrayOutputStream()

Description copied from interface: HecFile

Get a ByteArrayOutputStream for this file.

Specified by:

getByteArrayOutputStream in interface HecFile

Returns:

See Also:

• HecFile.getByteArrayOutputStream()

getCheckSum

public long getCheckSum()

Description copied from interface: HecFile

Get the check sum for this file.

Specified by:

getCheckSum in interface HecFile

Returns:

See Also:

• HecFile.getCheckSum()

getDataInputStream

public DataInputStream getDataInputStream()

Description copied from interface: HecFile

Get a DataInputStream for this file.

Specified by:

getDataInputStream in interface HecFile

Returns:

See Also:

• HecFile.getDataInputStream()

getDataOutputStream

public DataOutputStream getDataOutputStream()

Description copied from interface: HecFile

Get a DataOutputStream for writing to this file.

Specified by:

getDataOutputStream in interface HecFile

Returns:

See Also:

• HecFile.getDataOutputStream()

getEndianInputStream

public EndianInputStream getEndianInputStream()

Description copied from interface: HecFile

Get an EndianInputStream for this file.

Specified by:

getEndianInputStream in interface HecFile

Returns:

See Also:

• HecFile.getEndianInputStream()

getEndianOutputStream

public EndianOutputStream getEndianOutputStream()

Description copied from interface: HecFile

Get an EndianOutputStream for this file.

Specified by:

getEndianOutputStream in interface HecFile

Returns:

See Also:

• HecFile.getEndianOutputStream()

getObjectInputStream

public ObjectInputStream getObjectInputStream()

Description copied from interface: HecFile

Get an ObjectInputStream for this file.

Specified by:

getObjectInputStream in interface HecFile

Returns:

See Also:

• HecFile.getObjectInputStream()

getObjectOutputStream

public ObjectOutputStream getObjectOutputStream()
                                         throws IOException

Description copied from interface: HecFile

Get an ObjectOutputStream for this file.

Specified by:

getObjectOutputStream in interface HecFile

Returns:

Throws:

IOException

See Also:

• HecFile.getObjectOutputStream()

getUsingCompression

public boolean getUsingCompression()

Description copied from interface: HecFile

return whether this HecFile is using Compression to read/write data to the RmiFile

Specified by:

getUsingCompression in interface HecFile

Returns:

See Also:

• HecFile.getUsingCompression()

isNetworked

public boolean isNetworked()

Description copied from interface: HecFile

Get whether this HecFile represents a networked or local file.

Specified by:

isNetworked in interface HecFile

Returns:

See Also:

• HecFile.isNetworked()

lockFile

public boolean lockFile(FileLock fLock)

Description copied from interface: HecFile

Lock this file with fLock.

Specified by:

lockFile in interface HecFile

Parameters:

fLock -

Returns:

See Also:

• HecFile.lockFile(hec.io.FileLock)

notify

public void notify(String message)

Description copied from interface: HecFile

Send message to all callback objects registered with this file.

Specified by:

notify in interface HecFile

Parameters:

message -

See Also:

• HecFile.notify(java.lang.String)

save

public boolean save()

Description copied from interface: HecFile

Save the contents of any writers that are currently in use.

Specified by:

save in interface HecFile

Returns:

See Also:

• HecFile.save()

setByteArray

public boolean setByteArray(byte[] byteArray)

Description copied from interface: HecFile

Set this HecFile's data to byteArray starting at the beginning of the file

Specified by:

setByteArray in interface HecFile

Parameters:

byteArray -

Returns:

See Also:

• HecFile.setByteArray(byte[])

setUseCompression

public void setUseCompression(boolean compress)

Description copied from interface: HecFile

set whether this HecFile should use compression to read/write data to/from the RmiFile

Specified by:

setUseCompression in interface HecFile

Parameters:

compress -

See Also:

• HecFile.setUseCompression(boolean)

unlockFile

public boolean unlockFile(FileLock fLock)

Description copied from interface: HecFile

Unlock this file with fLock.

Specified by:

unlockFile in interface HecFile

Parameters:

fLock -

Returns:

See Also:

• HecFile.unlockFile(hec.io.FileLock)

writeBytes

public void writeBytes(long bytePos,
 byte[] bytes)

Specified by:

writeBytes in interface HecFile

writeFloat

public void writeFloat(long bytePos,
 float f)

Description copied from interface: HecFile

Write a float f to position bytePos in this HecFile.

Specified by:

writeFloat in interface HecFile

Parameters:

bytePos -

f -

See Also:

• HecFile.writeFloat(long, float)