FlushedScanHandle (Apache Derby V10.14 Internals)

java.lang.Object
- org.apache.derby.impl.store.raw.log.FlushedScanHandle

All Implemented Interfaces:: ScanHandle

public class FlushedScanHandle
extends java.lang.Object
implements ScanHandle

Field Summary

Fields
Modifier and Type	Field	Description
`(package private) StreamLogScan`	`fs`
`(package private) int`	`groupsIWant`
`(package private) LogFactory`	`lf`
`(package private) LogRecord`	`lr`
`(package private) ArrayInputStream`	`rawInput`
`(package private) boolean`	`readOptionalData`

Constructor Summary

Constructors
Constructor Description

FlushedScanHandle(LogToFile lf, DatabaseInstant start, int groupsIWant)

Constructors
Constructor	Description
`FlushedScanHandle(LogToFile lf, DatabaseInstant start, int groupsIWant)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Close this scan.
`int`	`getGroup()`	Get the group for the current log record.
`DatabaseInstant`	`getInstant()`	Get the DatabaseInstant for the current log record.
`Loggable`	`getLoggable()`	Get the Loggable associated with the currentLogRecord
`java.io.InputStream`	`getOptionalData()`	Get an InputStream for reading the optional data associated with the current log record.
`java.lang.Object`	`getTransactionId()`	Get the TransactionId for the current log record.
`boolean`	`next()`	Position to the next log record.

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

- Field Detail
  - lf
```
LogFactory lf
```
  - fs
```
StreamLogScan fs
```
  - lr
```
LogRecord lr
```
  - readOptionalData
```
boolean readOptionalData
```
  - groupsIWant
```
int groupsIWant
```
  - rawInput
```
ArrayInputStream rawInput
```
- Constructor Detail
  - FlushedScanHandle
```
FlushedScanHandle(LogToFile lf,
                  DatabaseInstant start,
                  int groupsIWant)
           throws StandardException
```
    Throws:
    
    StandardException
- Method Detail
  - next
```
public boolean next()
             throws StandardException
```
    Description copied from interface: ScanHandle
    
    Position to the next log record.
    
    Specified by:
    
    next in interface ScanHandle
    
    Returns:
    
    true if the log contains a next flushed log record and false otherwise. If this returns false it is incorrect to make any of the other calls on this interface.
    
    Throws:
    
    StandardException - Oops
  - getGroup
```
public int getGroup()
             throws StandardException
```
    Get the group for the current log record.
    
    Specified by:
    
    getGroup in interface ScanHandle
    
    Throws:
    
    StandardException - Oops
  - getLoggable
```
public Loggable getLoggable()
                     throws StandardException
```
    Get the Loggable associated with the currentLogRecord
    
    Specified by:
    
    getLoggable in interface ScanHandle
    
    Throws:
    
    StandardException - Oops
  - getOptionalData
```
public java.io.InputStream getOptionalData()
                                    throws StandardException
```
    Description copied from interface: ScanHandle
    
    Get an InputStream for reading the optional data associated with the current log record. This may only be called once per log record.
    
    Specified by:
    
    getOptionalData in interface ScanHandle
    
    Throws:
    
    StandardException - Oops
  - getInstant
```
public DatabaseInstant getInstant()
                           throws StandardException
```
    Description copied from interface: ScanHandle
    
    Get the DatabaseInstant for the current log record.
    
    Specified by:
    
    getInstant in interface ScanHandle
    
    Throws:
    
    StandardException - Oops
  - getTransactionId
```
public java.lang.Object getTransactionId()
                                  throws StandardException
```
    Description copied from interface: ScanHandle
    
    Get the TransactionId for the current log record.
    
    Specified by:
    
    getTransactionId in interface ScanHandle
    
    Throws:
    
    StandardException - Oops
  - close
```
public void close()
```
    Description copied from interface: ScanHandle
    
    Close this scan.
    
    Specified by:
    
    close in interface ScanHandle

Class FlushedScanHandle

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lf

fs

lr

readOptionalData

groupsIWant

rawInput

Constructor Detail

FlushedScanHandle

Method Detail

next

getGroup

getLoggable

getOptionalData

getInstant

getTransactionId

close