LocalFileStorage 40.0.0 API

All Implemented Interfaces:

org.ossreviewtoolkit.utils.ort.storage.FileStorage
```
public class LocalFileStorage
 implements FileStorage
                    
```
A FileStorage that stores files in a directory of the local file system. The read and write operations are Synchronized.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final File`	`directory`

Constructor Summary

Constructors
Constructor	Description
`LocalFileStorage(File directory)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final File`	`getDirectory()`	The directory used to store files in.
`String`	`transformPath(String path)`	Return the internally used path, which might differ from the provided path e.g.
`Boolean`	`exists(String path)`	Return whether the given path exists or not.
`InputStream`	`read(String path)`	Read the file at path.
`Unit`	`write(String path, InputStream inputStream)`	Write the data from inputStream to the file at path.
`Boolean`	`delete(String path)`	Delete the file at the given path and return whether the operation was successful.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LocalFileStorage
```
LocalFileStorage(File directory)
```
- Method Detail
  - getDirectory
```
 final File getDirectory()
```
    The directory used to store files in.
  - transformPath
```
 String transformPath(String path)
```
    Return the internally used path, which might differ from the provided path e.g. in case a suffix is added to denote a compression scheme.
  - exists
```
 Boolean exists(String path)
```
    Return whether the given path exists or not.
  - read
```
@Synchronized() InputStream read(String path)
```
    Read the file at path. It is the caller's responsibility to close the returned InputStream after consuming it.
  - write
```
@Synchronized() Unit write(String path, InputStream inputStream)
```
    Write the data from inputStream to the file at path. If the file already exists it is overwritten. The provided inputStream is closed after writing it to the file.
  - delete
```
@Synchronized() Boolean delete(String path)
```
    Delete the file at the given path and return whether the operation was successful.