Package org.apache.lucene.benchmark.byTask.utils

# Class StreamUtils

java.lang.Object
org.apache.lucene.benchmark.byTask.utils.StreamUtils

public class StreamUtils extends Object
Stream utilities.

## Nested Class Summary

Nested Classes
Modifier and Type
Class
Description
`static enum`
`StreamUtils.Type`
File format type

## Field Summary

Fields
Modifier and Type
Field
Description
`static final int`
`BUFFER_SIZE`
Buffer size used across the benchmark package

## Constructor Summary

Constructors
Constructor
Description
`StreamUtils()`

## Method Summary

Modifier and Type
Method
Description
`static InputStream`
`inputStream(Path file)`
Returns an `InputStream` over the requested file.
`static OutputStream`
`outputStream(Path file)`
Returns an `OutputStream` over the requested file, identifying the appropriate `OutputStream` instance similar to `inputStream(Path)`.

### Methods inherited from class java.lang.Object

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

## Field Details

### BUFFER_SIZE

public static final int BUFFER_SIZE
Buffer size used across the benchmark package

See Also:
  - Constant Field Values

## Constructor Details

### StreamUtils

public StreamUtils()

## Method Details

### inputStream

public static InputStream inputStream(Path file) throws IOException
Returns an `InputStream` over the requested file. This method attempts to identify the appropriate `InputStream` instance to return based on the file name (e.g., if it ends with .bz2 or .bzip, return a 'bzip' `InputStream`).

Throws:
  `IOException`

### outputStream

public static OutputStream outputStream(Path file) throws IOException
Returns an `OutputStream` over the requested file, identifying the appropriate `OutputStream` instance similar to `inputStream(Path)`.

Throws:
  `IOException`