System.IO

Class FileStream

java.lang.Object

System.IO.Stream

System.IO.FileStream

All Implemented Interfaces:

IDisposable

Direct Known Subclasses:

IsolatedStorageFileStream

public class FileStream
extends Stream

When it is called by an elevated-trust application, exposes a System.IO.Stream around a file, supporting both synchronous and asynchronous read and write operations.

Author:

Halofreak1990

Field Summary

Fields inherited from class System.IO.Stream

Null

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileStream()
	FileStream(java.lang.String path, FileMode mode) When it is called by trusted applications, initializes a new instance of the System.IO.FileStream class with the specified path and creation mode.
	FileStream(java.lang.String path, FileMode mode, java.util.EnumSet<FileAccess> access) When it is called by trusted applications, initializes a new instance of the System.IO.FileStream class with the specified path, creation mode, and read/write permission.
	FileStream(java.lang.String path, FileMode mode, java.util.EnumSet<FileAccess> access, java.util.EnumSet<FileShare> share)
	FileStream(java.lang.String path, FileMode mode, java.util.EnumSet<FileAccess> access, java.util.EnumSet<FileShare> share, int bufferSize)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	CanRead() When overridden in a derived class, gets a value indicating whether the current stream supports reading.
boolean	CanSeek() When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
boolean	CanWrite() When overridden in a derived class, gets a value indicating whether the current stream supports writing.
protected void	finalize() Ensures that resources are freed and other cleanup operations are performed when the garbage collector reclaims the FileStream.
void	Flush() When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
java.lang.String	getName()
long	getPosition() When overridden in a derived class, gets the position within the current stream.
long	Length() When overridden in a derived class, gets the length in bytes of the stream.
int	Read(byte[] buffer, int offset, int count) When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
long	Seek(long offset, SeekOrigin origin) When overridden in a derived class, sets the position within the current stream.
void	SetLength(long value) When overridden in a derived class, sets the length of the current stream.
void	setPosition(long value) When overridden in a derived class, sets the position within the current stream.
void	Write(byte[] buffer, int offset, int count) When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Methods inherited from class System.IO.Stream

BeginRead, BeginWrite, CanTimeout, Close, Dispose, Dispose, EndRead, EndWrite, ReadByte, WriteByte

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStream

protected FileStream()

FileStream

public FileStream(java.lang.String path,
          FileMode mode)

When it is called by trusted applications, initializes a new instance of the System.IO.FileStream class with the specified path and creation mode.

Parameters:

path - A relative or absolute path for the file that the current FileStream object will encapsulate.

mode - A System.IO.FileMode constant that determines how to open or create the file.

Throws:

ArgumentException - path is an empty string (""), contains only white space, or contains one or more invalid characters. -or-path refers to a non-file device, such as "con:", "com1:", "lpt1:", etc. in an NTFS environment.

NotSupportedException - path refers to a non-file device, such as "con:", "com1:", "lpt1:", etc. in a non-NTFS environment.

ArgumentNullException - path is null.

System.Security.SecurityException - The caller does not have the required permission.

FileNotFoundException - The file cannot be found, such as when mode is FileMode.Truncate or FileMode.Open, and the file specified by path does not exist. The file must already exist in these modes.

IOException - An I/O error occurs, such as specifying FileMode.CreateNew and the file specified by path already exists.-or-The stream has been closed.

PathTooLongException - The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.

FileStream

public FileStream(java.lang.String path,
          FileMode mode,
          java.util.EnumSet<FileAccess> access)

When it is called by trusted applications, initializes a new instance of the System.IO.FileStream class with the specified path, creation mode, and read/write permission.

Parameters:

path -

mode -

access -

FileStream

public FileStream(java.lang.String path,
          FileMode mode,
          java.util.EnumSet<FileAccess> access,
          java.util.EnumSet<FileShare> share)

Parameters:

path -

mode -

access -

share -

FileStream

public FileStream(java.lang.String path,
          FileMode mode,
          java.util.EnumSet<FileAccess> access,
          java.util.EnumSet<FileShare> share,
          int bufferSize)

Parameters:

path -

mode -

access -

share -

bufferSize -

Method Detail

CanRead

public boolean CanRead()

Description copied from class: Stream

When overridden in a derived class, gets a value indicating whether the current stream supports reading.

Specified by:

CanRead in class Stream

Returns:

true if the stream supports reading; otherwise, false.

CanSeek

public boolean CanSeek()

Description copied from class: Stream

When overridden in a derived class, gets a value indicating whether the current stream supports seeking.

Specified by:

CanSeek in class Stream

Returns:

true if the stream supports seeking; otherwise, false.

CanWrite

public boolean CanWrite()

Description copied from class: Stream

When overridden in a derived class, gets a value indicating whether the current stream supports writing.

Specified by:

CanWrite in class Stream

Returns:

true if the stream supports writing; otherwise, false.

Length

public long Length()

Description copied from class: Stream

When overridden in a derived class, gets the length in bytes of the stream.

Specified by:

Length in class Stream

Returns:

A long value representing the length of the stream in bytes.

getName

public java.lang.String getName()

getPosition

public long getPosition()

Description copied from class: Stream

When overridden in a derived class, gets the position within the current stream.

Specified by:

getPosition in class Stream

Returns:

The current position within the stream.

setPosition

public void setPosition(long value)

Description copied from class: Stream

When overridden in a derived class, sets the position within the current stream.

Specified by:

setPosition in class Stream

Parameters:

value - The new position within the stream.

finalize

protected void finalize()

Ensures that resources are freed and other cleanup operations are performed when the garbage collector reclaims the FileStream.

Overrides:

finalize in class java.lang.Object

Flush

public void Flush()

Description copied from class: Stream

When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.

Specified by:

Flush in class Stream

Read

public int Read(byte[] buffer,
       int offset,
       int count)

Description copied from class: Stream

When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Specified by:

Read in class Stream

Parameters:

buffer - An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.

offset - The zero-based byte offset in buffer at which to begin storing the data read from the current stream.

count - The maximum number of bytes to be read from the current stream.

Returns:

The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

Seek

public long Seek(long offset,
        SeekOrigin origin)

Description copied from class: Stream

When overridden in a derived class, sets the position within the current stream.

Specified by:

Seek in class Stream

Parameters:

offset - A byte offset relative to the origin parameter.

origin - A value of type System.IO.SeekOrigin indicating the reference point used to obtain the new position.

Returns:

The new position within the current stream.

SetLength

public void SetLength(long value)

Description copied from class: Stream

When overridden in a derived class, sets the length of the current stream.

Specified by:

SetLength in class Stream

Parameters:

value - The desired length of the current stream in bytes.

Write

public void Write(byte[] buffer,
         int offset,
         int count)

Description copied from class: Stream

When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Specified by:

Write in class Stream

Parameters:

buffer -

offset -

count -

Throws:

ArgumentNullException - buffer is null.

ArgumentOutOfRangeException