BaseBitPac (SoftLib 1.1.14-SNAPSHOT API)

java.lang.Object
- net.siisise.io.ReadBase
- - net.siisise.io.Base
  - - net.siisise.io.Edit
    - - net.siisise.io.BasePacket
      - net.siisise.io.BaseBitPac

すべての実装されたインタフェース:

Closeable, AutoCloseable, ByteChannel, Channel, ReadableByteChannel, WritableByteChannel, BackPacket, BinInput, BitPacket, FrontPacket, IndexEdit, IndexInput, IndexOutput, Input, Output, Packet, RevInput, RevOutput

直系の既知のサブクラス:

BigBitPacket, LittleBitPacket
```
public abstract class BaseBitPac
extends BasePacket
implements BitPacket
```
ビット操作用. index系まだつかえない. 上位ビット優先(Big Endian)/下位ビット(Little Endian)優先共通実装

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプクラスと説明

class BaseBitPac.BitInputStream

class BaseBitPac.BitOutputStream
- インタフェースから継承されたネストされたクラス/インタフェース net.siisise.io.Input
  Input.AbstractInput
- インタフェースから継承されたネストされたクラス/インタフェース net.siisise.io.Output
  Output.AbstractOutput
- インタフェースから継承されたネストされたクラス/インタフェース net.siisise.io.BinInput
  BinInput.XorInput

ネストされたクラス
修飾子とタイプ	クラスと説明
`class`	`BaseBitPac.BitInputStream`
`class`	`BaseBitPac.BitOutputStream`

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected BaseBitPac.BitInputStream`	`backIn`
`protected BaseBitPac.BitOutputStream`	`backOut`
`protected BaseBitPac.BitInputStream`	`in`
`protected BaseBitPac.BitOutputStream`	`out`
`protected Packet`	`pac`
`protected int`	`readPadding` 前方空白量
`protected int`	`writePadding` 後方空白量

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

BaseBitPac()

コンストラクタ
コンストラクタと説明
`BaseBitPac()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`add(long index, byte[] d, int srcOffset, int length)` バイト列の一部を追加.
`int`	`backRead(byte[] buf, int offset, int length)` 逆から読む.
`long`	`backReadBit(byte[] data, long offsetBit, long length)`
`int`	`backReadInt(int bit)`
`void`	`backWrite(byte[] data, int offset, int length)` 読み出しの手前にデータを足す.
`void`	`backWriteBit(BitPacket pac)`
`void`	`backWriteBit(BitPacket pac, long bitLength)`
`void`	`backWriteBit(byte[] data, long bitOffset, long bitLength)`
`void`	`backWriteBit(int data, int bitLength)`
`long`	`bitLength()`
`BaseBitPac`	`del(long index, byte[] d, int offset, int length)`
`void`	`del(long index, long size)`
`BaseBitPac`	`get(long index, byte[] b, int offset, int length)` length サイズを読む.
`BaseBitPac.BitInputStream`	`getBackInputStream()`
`BaseBitPac.BitOutputStream`	`getBackOutputStream()` 書き戻す用.
`BaseBitPac.BitInputStream`	`getInputStream()` ストリームと完全互換ではないがそれっぽくしてくれる.
`BaseBitPac.BitOutputStream`	`getOutputStream()`
`long`	`length()` 端数は含まないバイト列として返せる値.
`void`	`put(long index, byte[] d, int srcOffset, int length)`
`int`	`read(byte[] data, int offset, int length)` 8ビット単位で転送.
`long`	`readBit(byte[] data, long offsetBit, long length)` readのビット版入れ物はbyte列左詰め \|01234567\|89ABCDEF\|
`int`	`readInt(int bit)`
`BitPacket`	`readPac(int length)`
`void`	`write(byte[] data, int offset, int length)` 上限のない書き込み.
`void`	`writeBit(BitPacket pac)`
`void`	`writeBit(BitPacket bp, long bitLength)`
`void`	`writeBit(byte[] data, long bitOffset, long bitLength)`
`void`	`writeBit(int data, int bitLength)`

クラスから継承されたメソッド net.siisise.io.BasePacket
backLength, put

クラスから継承されたメソッド net.siisise.io.Edit
add, add, del, del, write

クラスから継承されたメソッド net.siisise.io.Base
backWrite, backWrite, backWrite, backWrite, close, dbackWrite, dwrite, flush, isOpen, put, put, put, put, write, write, write, write

クラスから継承されたメソッド net.siisise.io.ReadBase
back, backRead, backRead, backReadPacket, backSize, get, get, get, get, read, read, read, readPacket, revGet, revGet, revGet, size, skip, toByteArray

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド net.siisise.io.Input
get, get, get, get, read, read, read, read, readPacket, size, skip, skipImpl, splitImpl, toByteArray

インタフェースから継承されたメソッド net.siisise.io.RevOutput
backWrite, backWrite, backWrite, backWrite, backWrite, dbackWrite, flush

インタフェースから継承されたメソッド net.siisise.io.Output
dwrite, put, put, put, write, write, write, write, write

インタフェースから継承されたメソッド net.siisise.io.RevInput
back, backImpl, backLength, backRead, backRead, backReadPacket, backSize, revGet, splitImpl

インタフェースから継承されたメソッド net.siisise.io.IndexEdit
add, add, del, del

インタフェースから継承されたメソッド net.siisise.io.IndexInput
get, get

インタフェースから継承されたメソッド net.siisise.io.IndexOutput
put, put

インタフェースから継承されたメソッド net.siisise.io.BinInput
xor

インタフェースから継承されたメソッド java.nio.channels.ReadableByteChannel
read

- フィールドの詳細
  - pac
```
protected Packet pac
```
  - readPadding
```
protected int readPadding
```
    前方空白量
  - writePadding
```
protected int writePadding
```
    後方空白量
  - in
```
protected BaseBitPac.BitInputStream in
```
  - out
```
protected BaseBitPac.BitOutputStream out
```
  - backIn
```
protected BaseBitPac.BitInputStream backIn
```
  - backOut
```
protected BaseBitPac.BitOutputStream backOut
```
- コンストラクタの詳細
  - BaseBitPac
```
public BaseBitPac()
```
- メソッドの詳細
  - getInputStream
```
public BaseBitPac.BitInputStream getInputStream()
```
    インタフェースからコピーされた説明: Input
    
    ストリームと完全互換ではないがそれっぽくしてくれる.
    
    定義:
    
    getInputStream インタフェース内 Input
    
    オーバーライド:
    
    getInputStream クラス内 ReadBase
    
    戻り値:
    
    InputStream への変換
  - getOutputStream
```
public BaseBitPac.BitOutputStream getOutputStream()
```
    定義:
    
    getOutputStream インタフェース内 Output
    
    オーバーライド:
    
    getOutputStream クラス内 Base
  - getBackInputStream
```
public BaseBitPac.BitInputStream getBackInputStream()
```
    定義:
    
    getBackInputStream インタフェース内 RevInput
    
    オーバーライド:
    
    getBackInputStream クラス内 ReadBase
  - getBackOutputStream
```
public BaseBitPac.BitOutputStream getBackOutputStream()
```
    インタフェースからコピーされた説明: RevOutput
    
    書き戻す用. Packetの頭にデータが増える. 頭に書き足す/戻すので繋ぎ方に注意.
    
    定義:
    
    getBackOutputStream インタフェース内 RevOutput
    
    オーバーライド:
    
    getBackOutputStream クラス内 Base
    
    戻り値:
    
    特殊用途OutputStream
  - bitLength
```
public long bitLength()
```
    定義:
    
    bitLength インタフェース内 BitPacket
  - length
```
public long length()
```
    端数は含まないバイト列として返せる値.
    
    定義:
    
    length インタフェース内 Input
    
    戻り値:
  - read
```
public int read(byte[] data,
                int offset,
                int length)
```
    8ビット単位で転送. 端数は残る。
    
    定義:
    
    read インタフェース内 Input
    
    パラメータ:
    
    data - 転送先配列
    
    offset - バッファ位置
    
    length - サイズ
    
    戻り値:
    
    転送可能なバイト長。
  - readInt
```
public int readInt(int bit)
```
    定義:
    
    readInt インタフェース内 BitPacket
    
    パラメータ:
    
    bit - 1～32ぐらい
    
    戻り値:
    
    下位ビットを指定ビット分上から埋める |xx012345|
  - readBit
```
public long readBit(byte[] data,
                    long offsetBit,
                    long length)
```
    readのビット版入れ物はbyte列左詰め |01234567|89ABCDEF|
    
    定義:
    
    readBit インタフェース内 BitPacket
    
    パラメータ:
    
    data - 戻りデータ
    
    offsetBit - 開始ビット位置
    
    length - ビット長
    
    戻り値:
  - readPac
```
public BitPacket readPac(int length)
```
    定義:
    
    readPac インタフェース内 BitPacket
  - backRead
```
public int backRead(byte[] buf,
                    int offset,
                    int length)
```
    インタフェースからコピーされた説明: RevInput
    
    逆から読む. 短い場合は後ろ(offset + length)から詰める.
    
    定義:
    
    backRead インタフェース内 RevInput
    
    パラメータ:
    
    buf - バッファ
    
    offset - バッファ位置
    
    length - 長さ
    
    戻り値:
    
    読めた長さ
  - backReadInt
```
public int backReadInt(int bit)
```
    定義:
    
    backReadInt インタフェース内 BitPacket
  - backReadBit
```
public long backReadBit(byte[] data,
                        long offsetBit,
                        long length)
```
    定義:
    
    backReadBit インタフェース内 BitPacket
  - write
```
public void write(byte[] data,
                  int offset,
                  int length)
```
    インタフェースからコピーされた説明: Output
    
    上限のない書き込み. OutputStream 互換っぽくする。 Blockの上限ではなんとかする?
    
    定義:
    
    write インタフェース内 Output
    
    パラメータ:
    
    data - データ
    
    offset - データ位置
    
    length - データサイズ
  - writeBit
```
public void writeBit(int data,
                     int bitLength)
```
    定義:
    
    writeBit インタフェース内 BitPacket
  - writeBit
```
public void writeBit(BitPacket pac)
```
    定義:
    
    writeBit インタフェース内 BitPacket
  - writeBit
```
public void writeBit(BitPacket bp,
                     long bitLength)
```
    定義:
    
    writeBit インタフェース内 BitPacket
  - writeBit
```
public void writeBit(byte[] data,
                     long bitOffset,
                     long bitLength)
```
    定義:
    
    writeBit インタフェース内 BitPacket
  - backWrite
```
public void backWrite(byte[] data,
                      int offset,
                      int length)
```
    インタフェースからコピーされた説明: RevOutput
    
    読み出しの手前にデータを足す. 読んだデータを戻すのに便利.
    
    定義:
    
    backWrite インタフェース内 RevOutput
    
    パラメータ:
    
    data - データを含む配列.
    
    offset - 開始位置
    
    length - データ長
  - backWriteBit
```
public void backWriteBit(int data,
                         int bitLength)
```
    定義:
    
    backWriteBit インタフェース内 BitPacket
  - backWriteBit
```
public void backWriteBit(BitPacket pac)
```
    定義:
    
    backWriteBit インタフェース内 BitPacket
  - backWriteBit
```
public void backWriteBit(BitPacket pac,
                         long bitLength)
```
    定義:
    
    backWriteBit インタフェース内 BitPacket
  - backWriteBit
```
public void backWriteBit(byte[] data,
                         long bitOffset,
                         long bitLength)
```
    定義:
    
    backWriteBit インタフェース内 BitPacket
  - get
```
public BaseBitPac get(long index,
                      byte[] b,
                      int offset,
                      int length)
```
    インタフェースからコピーされた説明: IndexInput
    
    length サイズを読む. 読めないときはException Buffer 系にあわせたが、Channel系にあわせる方がいいのかもしれない. Packetを読んでもとりあえず消えないことにする.
    
    定義:
    
    get インタフェース内 IndexInput
    
    パラメータ:
    
    index - 位置
    
    b - バッファ
    
    offset - バッファ位置
    
    length - サイズ
    
    戻り値:
    
    これ
  - put
```
public void put(long index,
                byte[] d,
                int srcOffset,
                int length)
```
    定義:
    
    put インタフェース内 IndexOutput
  - add
```
public void add(long index,
                byte[] d,
                int srcOffset,
                int length)
```
    インタフェースからコピーされた説明: IndexEdit
    
    バイト列の一部を追加.
    
    定義:
    
    add インタフェース内 IndexEdit
    
    パラメータ:
    
    index - 位置
    
    d - 追加するデータ
    
    srcOffset - データの位置
    
    length - データのサイズ
  - del
```
public void del(long index,
                long size)
```
    定義:
    
    del インタフェース内 IndexEdit
  - del
```
public BaseBitPac del(long index,
                      byte[] d,
                      int offset,
                      int length)
```
    定義:
    
    del インタフェース内 IndexEdit
    
    定義:
    
    del クラス内 BasePacket

クラス BaseBitPac

ネストされたクラスのサマリー

インタフェースから継承されたネストされたクラス/インタフェース net.siisise.io.Input

インタフェースから継承されたネストされたクラス/インタフェース net.siisise.io.Output

インタフェースから継承されたネストされたクラス/インタフェース net.siisise.io.BinInput

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド net.siisise.io.BasePacket

クラスから継承されたメソッド net.siisise.io.Edit

クラスから継承されたメソッド net.siisise.io.Base

クラスから継承されたメソッド net.siisise.io.ReadBase

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド net.siisise.io.Input

インタフェースから継承されたメソッド net.siisise.io.RevOutput

インタフェースから継承されたメソッド net.siisise.io.Output

インタフェースから継承されたメソッド net.siisise.io.RevInput

インタフェースから継承されたメソッド net.siisise.io.IndexEdit

インタフェースから継承されたメソッド net.siisise.io.IndexInput

インタフェースから継承されたメソッド net.siisise.io.IndexOutput

インタフェースから継承されたメソッド net.siisise.io.BinInput

インタフェースから継承されたメソッド java.nio.channels.ReadableByteChannel

フィールドの詳細

pac

readPadding

writePadding

in

out

backIn

backOut

コンストラクタの詳細

BaseBitPac

メソッドの詳細

getInputStream

getOutputStream

getBackInputStream

getBackOutputStream

bitLength

length

read

readInt

readBit

readPac

backRead

backReadInt

backReadBit

write

writeBit

writeBit

writeBit

writeBit

backWrite

backWriteBit

backWriteBit

backWriteBit

backWriteBit

get

put

add

del

del