HRegion.FlushResultImpl (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.regionserver.HRegion.FlushResultImpl

All Implemented Interfaces:

Region.FlushResult

Enclosing class:

HRegion
```
public static class HRegion.FlushResultImpl
extends Object
implements Region.FlushResult
```
Objects from this class are created when flushing to describe all the different states that that method ends up in. The Result enum describes those states. The sequence id should only be specified if the flush was successful, and the failure message should only be specified if it didn't flush.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.regionserver.Region.FlushResult
  Region.FlushResult.Result

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) String`	`failureReason`
`(package private) long`	`flushSequenceId`
`(package private) Region.FlushResult.Result`	`result`
`(package private) boolean`	`wroteFlushWalMarker`

Constructor Summary

Constructors
Constructor and Description
`HRegion.FlushResultImpl(Region.FlushResult.Result result, long flushSequenceId)` Convenience constructor to use when the flush is successful, the failure message is set to null.
`HRegion.FlushResultImpl(Region.FlushResult.Result result, long flushSequenceId, String failureReason, boolean wroteFlushMarker)` Constructor with all the parameters.
`HRegion.FlushResultImpl(Region.FlushResult.Result result, String failureReason, boolean wroteFlushMarker)` Convenience constructor to use when we cannot flush.

Method Summary

Methods
Modifier and Type	Method and Description
`Region.FlushResult.Result`	`getResult()`
`boolean`	`isCompactionNeeded()` Convenience method, the equivalent of checking if result is FLUSHED_COMPACTION_NEEDED.
`boolean`	`isFlushSucceeded()` Convenience method, the equivalent of checking if result is FLUSHED_NO_COMPACTION_NEEDED or FLUSHED_NO_COMPACTION_NEEDED.
`String`	`toString()`

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

- Field Detail
  - result
```
final Region.FlushResult.Result result
```
  - failureReason
```
final String failureReason
```
  - flushSequenceId
```
final long flushSequenceId
```
  - wroteFlushWalMarker
```
final boolean wroteFlushWalMarker
```
- Constructor Detail
  - HRegion.FlushResultImpl
```
HRegion.FlushResultImpl(Region.FlushResult.Result result,
                       long flushSequenceId)
```
    Convenience constructor to use when the flush is successful, the failure message is set to null.
    
    Parameters:
    result - Expecting FLUSHED_NO_COMPACTION_NEEDED or FLUSHED_COMPACTION_NEEDED.
    flushSequenceId - Generated sequence id that comes right after the edits in the memstores.
  - HRegion.FlushResultImpl
```
HRegion.FlushResultImpl(Region.FlushResult.Result result,
                       String failureReason,
                       boolean wroteFlushMarker)
```
    Convenience constructor to use when we cannot flush.
    
    Parameters:
    result - Expecting CANNOT_FLUSH_MEMSTORE_EMPTY or CANNOT_FLUSH.
    failureReason - Reason why we couldn't flush.
  - HRegion.FlushResultImpl
```
HRegion.FlushResultImpl(Region.FlushResult.Result result,
                       long flushSequenceId,
                       String failureReason,
                       boolean wroteFlushMarker)
```
    Constructor with all the parameters.
    
    Parameters:
    result - Any of the Result.
    flushSequenceId - Generated sequence id if the memstores were flushed else -1.
    failureReason - Reason why we couldn't flush, or null.
- Method Detail
  - isFlushSucceeded
```
public boolean isFlushSucceeded()
```
    Convenience method, the equivalent of checking if result is FLUSHED_NO_COMPACTION_NEEDED or FLUSHED_NO_COMPACTION_NEEDED.
    
    Specified by:
    
    isFlushSucceeded in interface Region.FlushResult
    
    Returns:
    true if the memstores were flushed, else false.
  - isCompactionNeeded
```
public boolean isCompactionNeeded()
```
    Convenience method, the equivalent of checking if result is FLUSHED_COMPACTION_NEEDED.
    
    Specified by:
    
    isCompactionNeeded in interface Region.FlushResult
    
    Returns:
    True if the flush requested a compaction, else false (doesn't even mean it flushed).
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getResult
```
public Region.FlushResult.Result getResult()
```
    Specified by:
    
    getResult in interface Region.FlushResult
    
    Returns:
    the detailed result code

Class HRegion.FlushResultImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.regionserver.Region.FlushResult

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

result

failureReason

flushSequenceId

wroteFlushWalMarker

Constructor Detail

HRegion.FlushResultImpl

HRegion.FlushResultImpl

HRegion.FlushResultImpl

Method Detail

isFlushSucceeded

isCompactionNeeded

toString

getResult