BaseDecoder (Apache HBase 1.2.12 API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.hadoop.hbase.codec.BaseDecoder

All Implemented Interfaces:

CellScanner, Codec.Decoder

Direct Known Subclasses:

CellCodec.CellDecoder, CellCodecWithTags.CellDecoder, KeyValueCodec.KeyValueDecoder, KeyValueCodecWithTags.KeyValueDecoder, MessageCodec.MessageDecoder, WALCellCodec.CompressedKvDecoder
```
@InterfaceAudience.LimitedPrivate(value={"Coprocesssor","Phoenix"})
public abstract class BaseDecoder
extends Object
implements Codec.Decoder
```
TODO javadoc

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class BaseDecoder.PBIS

Field Summary

Fields
Modifier and Type Field and Description

private Cell current

protected InputStream in

protected static org.apache.commons.logging.Log LOG

Constructor Summary

Constructors
Constructor and Description

BaseDecoder(InputStream in)

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`advance()` Advance the scanner 1 cell.
`Cell`	`current()`
`protected InputStream`	`getInputStream()`
`protected abstract Cell`	`parseCell()` Extract a Cell.
`private void`	`rethrowEofException(IOException ioEx)`

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

- Field Detail
  - LOG
```
protected static final org.apache.commons.logging.Log LOG
```
  - in
```
protected final InputStream in
```
  - current
```
private Cell current
```
- Constructor Detail
  - BaseDecoder
```
public BaseDecoder(InputStream in)
```
- Method Detail
  - advance
```
public boolean advance()
                throws IOException
```
    Description copied from interface: CellScanner
    
    Advance the scanner 1 cell.
    
    Specified by:
    
    advance in interface CellScanner
    
    Returns:
    true if the next cell is found and CellScanner.current() will return a valid Cell
    
    Throws:
    
    IOException
  - rethrowEofException
```
private void rethrowEofException(IOException ioEx)
                          throws IOException
```
    Throws:
    
    IOException
  - getInputStream
```
protected InputStream getInputStream()
```
  - parseCell
```
@NonNull
protected abstract Cell parseCell()
                           throws IOException
```
    Extract a Cell.
    
    Returns:
    a parsed Cell or throws an Exception. EOFException or a generic IOException maybe thrown if EOF is reached prematurely. Does not return null.
    
    Throws:
    
    IOException
  - current
```
public Cell current()
```
    Specified by:
    
    current in interface CellScanner
    
    Returns:
    the current Cell which may be mutable

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2007–2019 The Apache Software Foundation. All rights reserved.