com.caucho.quercus.lib.file

Class FileInput

java.lang.Object

java.io.InputStream

com.caucho.quercus.lib.file.ReadStreamInput

com.caucho.quercus.lib.file.FileInput

All Implemented Interfaces:

EnvCleanup, BinaryInput, BinaryStream, LockableStream, java.io.Closeable, java.lang.AutoCloseable

public class FileInput
extends ReadStreamInput
implements LockableStream, EnvCleanup

Represents a Quercus file open for reading

Field Summary

Fields inherited from interface com.caucho.quercus.lib.file.BinaryStream

SEEK_CUR, SEEK_END, SEEK_SET

Constructor Summary

Constructors

Constructor and Description
FileInput(Env env, Path path)

Method Summary

Modifier and Type	Method and Description
void	cleanup() Implements the EnvCleanup interface.
void	close() Closes the file.
long	getLength() Returns the number of bytes available to be read, 0 if not known.
Path	getPath() Returns the path.
boolean	lock(boolean shared, boolean block) Lock the shared advisory lock.
BinaryInput	openCopy() Opens a copy.
long	seek(long offset, int whence) Seek according to offset and whence.
Value	stat() Returns an array filled with stat information.
java.lang.String	toString() Converts to a string.
boolean	unlock() Unlock the advisory lock.

Methods inherited from class com.caucho.quercus.lib.file.ReadStreamInput

appendTo, closeRead, getAvailable, getInputStream, getPosition, getResourceType, init, isEOF, read, read, read, read, readLine, readOptionalLinefeed, setEncoding, setPosition, toJavaObject, unread, writeToStream

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

FileInput

public FileInput(Env env,
                 Path path)
          throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getPath

public Path getPath()

Returns the path.

openCopy

public BinaryInput openCopy()
                     throws java.io.IOException

Opens a copy.

Specified by:

openCopy in interface BinaryInput

Overrides:

openCopy in class ReadStreamInput

Throws:

java.io.IOException

getLength

public long getLength()

Returns the number of bytes available to be read, 0 if not known.

seek

public long seek(long offset,
                 int whence)

Description copied from interface: BinaryStream

Seek according to offset and whence. For fseek() compatibility in wrapped streams.

Specified by:

seek in interface BinaryStream

Overrides:

seek in class ReadStreamInput

lock

public boolean lock(boolean shared,
                    boolean block)

Lock the shared advisory lock.

Specified by:

lock in interface LockableStream

unlock

public boolean unlock()

Unlock the advisory lock.

Specified by:

unlock in interface LockableStream

stat

public Value stat()

Description copied from interface: BinaryStream

Returns an array filled with stat information. Mainly for wrapped stream functionality.

Specified by:

stat in interface BinaryStream

Overrides:

stat in class ReadStreamInput

close

public void close()

Description copied from class: ReadStreamInput

Closes the file.

Specified by:

close in interface BinaryInput

Specified by:

close in interface BinaryStream

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class ReadStreamInput

cleanup

public void cleanup()

Implements the EnvCleanup interface.

Specified by:

cleanup in interface EnvCleanup

toString

public java.lang.String toString()

Converts to a string.

Overrides:

toString in class ReadStreamInput