agi.foundation.infrastructure

(agi.foundation.core-2024r3.jar)

Class FileStreamFactory

java.lang.Object

agi.foundation.infrastructure.StreamFactory

agi.foundation.infrastructure.FileStreamFactory

public class FileStreamFactory
extends StreamFactory

A factory that can produce FileStream instances on demand. This type is used by classes that need to work with data from a stream from multiple threads simultaneously. They can use it to open the stream in each thread.

Constructor Summary

Constructors

Constructor and Description
FileStreamFactory(agi.foundation.compatibility.Func1<FileStream> func) Initializes a new instance with a provided delegate.
FileStreamFactory(String path, FileMode mode) Initializes a new instance of the factory that constructs a new FileStream with FileStream.FileStream(String,FileMode) when FileStreamFactory.openStream() is called.
FileStreamFactory(String path, FileMode mode, FileAccess access) Initializes a new instance of the factory that constructs a new FileStream with FileStream.FileStream(String,FileMode,FileAccess) when FileStreamFactory.openStream() is called.

Method Summary

Modifier and Type	Method and Description
FileStream	openFileStream() Opens a new FileStream.
InputStream	openStream() Opens a new InputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStreamFactory

public FileStreamFactory(@Nonnull
                         String path,
                         @Nonnull
                         FileMode mode)

Initializes a new instance of the factory that constructs a new FileStream with FileStream.FileStream(String,FileMode) when FileStreamFactory.openStream() is called.

Parameters:

path - The 'path' parameter passed to the FileStream constructor.

mode - The 'mode' parameter passed to the FileStream constructor.

FileStreamFactory

public FileStreamFactory(@Nonnull
                         String path,
                         @Nonnull
                         FileMode mode,
                         @Nonnull
                         FileAccess access)

Initializes a new instance of the factory that constructs a new FileStream with FileStream.FileStream(String,FileMode,FileAccess) when FileStreamFactory.openStream() is called.

Parameters:

path - The 'path' parameter passed to the FileStream constructor.

mode - The 'mode' parameter passed to the FileStream constructor.

access - The 'access' parameter passed to the FileStream constructor.

FileStreamFactory

public FileStreamFactory(@Nonnull
                         agi.foundation.compatibility.Func1<FileStream> func)

Initializes a new instance with a provided delegate. The given delegate must be safe to call from multiple threads simultaneously. In most situations, one of the other constructors should be used instead.

Parameters:

func - The function to call in order to open a file stream.

Throws:

ArgumentNullException - Thrown when func is null.

Method Detail

openStream

public InputStream openStream()

Opens a new InputStream.

Specified by:

openStream in class StreamFactory

Returns:

The opened stream.

openFileStream

@Nonnull
public FileStream openFileStream()

Opens a new FileStream.

Returns:

The opened stream.