Package hec.util

Class SimpleFile

java.lang.Object

java.io.File

hec.util.SimpleFile

All Implemented Interfaces:

hec.io.HecFile, Serializable, Comparable<File>

public class SimpleFile
extends File
implements hec.io.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)
void	close()
protected void	copyFile(File src, File dest)	copies src to dest - does no checking of the files.
BufferedWriter	getAppendedBufferedWriter()
DataOutputStream	getAppendedDataOutputStream()
BufferedReader	getBufferedReader()
BufferedWriter	getBufferedWriter()
byte[]	getByteArray()
byte[]	getByteArray(boolean compress)	Return a byte[] containing the data from the File.
byte[]	getByteArray(long off, int len)
ByteArrayInputStream	getByteArrayInputStream()
ByteArrayOutputStream	getByteArrayOutputStream()
long	getCheckSum()
DataInputStream	getDataInputStream()
DataOutputStream	getDataOutputStream()
hec.io.EndianInputStream	getEndianInputStream()
hec.io.EndianOutputStream	getEndianOutputStream()
ObjectInputStream	getObjectInputStream()
ObjectOutputStream	getObjectOutputStream()
boolean	getUsingCompression()
boolean	isNetworked()
boolean	lockFile(hec.io.FileLock fLock)
void	notify(String message)
boolean	save()
boolean	setByteArray(byte[] byteArray)
void	setUseCompression(boolean compress)
static void	setWriteToTmpFile(boolean writeToTmp)
boolean	unlockFile(hec.io.FileLock fLock)
void	writeBytes(long bytePos, byte[] bytes)
void	writeFloat(long bytePos, float f)

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)

Specified by:

appendByteArray in interface hec.io.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

Specified by:

close in interface hec.io.HecFile

Throws:

IOException

See Also:

• HecFile.close()

getAppendedBufferedWriter

public BufferedWriter getAppendedBufferedWriter()

Specified by:

getAppendedBufferedWriter in interface hec.io.HecFile

Returns:

See Also:

• HecFile.getAppendedBufferedWriter()

getAppendedDataOutputStream

public DataOutputStream getAppendedDataOutputStream()

Specified by:

getAppendedDataOutputStream in interface hec.io.HecFile

Returns:

See Also:

• HecFile.getAppendedDataOutputStream()

getBufferedReader

public BufferedReader getBufferedReader()

Specified by:

getBufferedReader in interface hec.io.HecFile

Returns:

See Also:

• HecFile.getBufferedReader()

getBufferedWriter

public BufferedWriter getBufferedWriter()

Specified by:

getBufferedWriter in interface hec.io.HecFile

Returns:

See Also:

• HecFile.getBufferedWriter()

getByteArray

public byte[] getByteArray()

Specified by:

getByteArray in interface hec.io.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)

Specified by:

getByteArray in interface hec.io.HecFile

Parameters:

off -

len -

Returns:

See Also:

• HecFile.getByteArray(long, int)

getByteArrayInputStream

public ByteArrayInputStream getByteArrayInputStream()

Specified by:

getByteArrayInputStream in interface hec.io.HecFile

Returns:

See Also:

• HecFile.getByteArrayInputStream()

getByteArrayOutputStream

public ByteArrayOutputStream getByteArrayOutputStream()

Specified by:

getByteArrayOutputStream in interface hec.io.HecFile

Returns:

See Also:

• HecFile.getByteArrayOutputStream()

getCheckSum

public long getCheckSum()

Specified by:

getCheckSum in interface hec.io.HecFile

Returns:

See Also:

• HecFile.getCheckSum()

getDataInputStream

public DataInputStream getDataInputStream()

Specified by:

getDataInputStream in interface hec.io.HecFile

Returns:

See Also:

• HecFile.getDataInputStream()

getDataOutputStream

public DataOutputStream getDataOutputStream()

Specified by:

getDataOutputStream in interface hec.io.HecFile

Returns:

See Also:

• HecFile.getDataOutputStream()

getEndianInputStream

public hec.io.EndianInputStream getEndianInputStream()

Specified by:

getEndianInputStream in interface hec.io.HecFile

Returns:

See Also:

• HecFile.getEndianInputStream()

getEndianOutputStream

public hec.io.EndianOutputStream getEndianOutputStream()

Specified by:

getEndianOutputStream in interface hec.io.HecFile

Returns:

See Also:

• HecFile.getEndianOutputStream()

getObjectInputStream

public ObjectInputStream getObjectInputStream()

Specified by:

getObjectInputStream in interface hec.io.HecFile

Returns:

See Also:

• HecFile.getObjectInputStream()

getObjectOutputStream

public ObjectOutputStream getObjectOutputStream()
                                         throws IOException

Specified by:

getObjectOutputStream in interface hec.io.HecFile

Returns:

Throws:

IOException

See Also:

• HecFile.getObjectOutputStream()

getUsingCompression

public boolean getUsingCompression()

Specified by:

getUsingCompression in interface hec.io.HecFile

Returns:

See Also:

• HecFile.getUsingCompression()

isNetworked

public boolean isNetworked()

Specified by:

isNetworked in interface hec.io.HecFile

Returns:

See Also:

• HecFile.isNetworked()

lockFile

public boolean lockFile(hec.io.FileLock fLock)

Specified by:

lockFile in interface hec.io.HecFile

Parameters:

fLock -

Returns:

See Also:

• HecFile.lockFile(hec.io.FileLock)

notify

public void notify(String message)

Specified by:

notify in interface hec.io.HecFile

Parameters:

message -

See Also:

• HecFile.notify(java.lang.String)

save

public boolean save()

Specified by:

save in interface hec.io.HecFile

Returns:

See Also:

• HecFile.save()

setByteArray

public boolean setByteArray(byte[] byteArray)

Specified by:

setByteArray in interface hec.io.HecFile

Parameters:

byteArray -

Returns:

See Also:

• HecFile.setByteArray(byte[])

setUseCompression

public void setUseCompression(boolean compress)

Specified by:

setUseCompression in interface hec.io.HecFile

Parameters:

compress -

See Also:

• HecFile.setUseCompression(boolean)

unlockFile

public boolean unlockFile(hec.io.FileLock fLock)

Specified by:

unlockFile in interface hec.io.HecFile

Parameters:

fLock -

Returns:

See Also:

• HecFile.unlockFile(hec.io.FileLock)

writeBytes

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

Specified by:

writeBytes in interface hec.io.HecFile

writeFloat

public void writeFloat(long bytePos,
 float f)

Specified by:

writeFloat in interface hec.io.HecFile

Parameters:

bytePos -

f -

See Also:

• HecFile.writeFloat(long, float)