AIInOut.AIFileSegmentInOut (AIGenPipeline Project 2.1.0 API)

java.lang.Object
- net.stoerr.ai.aigenpipeline.framework.task.AIInOut.AIFileSegmentInOut

All Implemented Interfaces:

AIInOut

Enclosing interface:

AIInOut
```
public static class AIInOut.AIFileSegmentInOut
extends Object
implements AIInOut
```
AIFileSegmentInOut is an implementation of AIInOut that reads from a segment of a segmented file.

Nested Class Summary
- Nested classes/interfaces inherited from interface net.stoerr.ai.aigenpipeline.framework.task.AIInOut
  AIInOut.AIFileInOut, AIInOut.AIFileSegmentInOut, AIInOut.AIStreamInOut

Field Summary

Fields
Modifier and Type Field Description

protected SegmentedFile segmentedFile

protected int segmentIndex

Constructor Summary

Constructors
Constructor Description

AIFileSegmentInOut(SegmentedFile segmentedFile, int segmentIndex)
Constructs an AIFileSegmentInOut instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`File`	`getFile()`	The underlying file.
`String`	`read()`	Reads the segment from the segmented file and returns its content as a string.
`String`	`toString()`
`void`	`write(String content)`	Writes a string to the segment of the segmented file.

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

Methods inherited from interface net.stoerr.ai.aigenpipeline.framework.task.AIInOut
exists, sameFile

- Field Detail
  - segmentedFile
```
protected final SegmentedFile segmentedFile
```
  - segmentIndex
```
protected final int segmentIndex
```
- Constructor Detail
  - AIFileSegmentInOut
```
public AIFileSegmentInOut(SegmentedFile segmentedFile,
                          int segmentIndex)
```
    Constructs an AIFileSegmentInOut instance.
    
    Parameters:
    
    segmentedFile - the segmented file to read from
    
    segmentIndex - the index of the segment to read
- Method Detail
  - read
```
public String read()
```
    Reads the segment from the segmented file and returns its content as a string.
    
    Specified by:
    
    read in interface AIInOut
    
    Returns:
    
    the segment content as a string
  - write
```
public void write(String content)
```
    Writes a string to the segment of the segmented file.
    
    Specified by:
    
    write in interface AIInOut
    
    Parameters:
    
    content - the string to write
  - getFile
```
public File getFile()
```
    Description copied from interface: AIInOut
    
    The underlying file.
    
    Specified by:
    
    getFile in interface AIInOut
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object