StreamFrontPacket (SoftLib 1.1.14-SNAPSHOT API)

java.lang.Object
- net.siisise.io.StreamFrontPacket

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

FrontPacket, Input, RevOutput
```
public class StreamFrontPacket
extends Object
implements FrontPacket
```
PacketのふりをするStream. Packet を InputStream の頭につけたい。 Streamとして振る舞うのがメイン。使い終わったStreamは閉じる.

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

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

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

StreamFrontPacket(InputStream in)

StreamFrontPacket(Reader reader)

コンストラクタ
コンストラクタと説明
`StreamFrontPacket(InputStream in)`
`StreamFrontPacket(Reader reader)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`backWrite(byte[] data)` 読み出しの手前にデータを足す.
`void`	`backWrite(byte[] data, int offset, int length)` 読み出しの手前にデータを足す.
`void`	`backWrite(int data)` 読み出しの手前に1バイト戻す.
`long`	`backWrite(RevInput rin)` 上限配慮あり.
`long`	`backWrite(RevInput rin, long length)` 逆書き込み
`void`	`close()` 連結した入力を閉じる.
`void`	`dbackWrite(byte[] data)` 複製しない(可能な場合)
`void`	`flush()`
`byte`	`get()`
`long`	`get(byte[] d, int offset, int length)`
`OutputStream`	`getBackOutputStream()` 書き戻す用.
`InputStream`	`getInputStream()` ストリームと完全互換ではないがそれっぽくしてくれる.
`long`	`length()` 読めるサイズ long版. 32ビットでは足りないかもと足してみた
`int`	`read()` InputStreamとの違い入力ブロックせずにデータ:0-255 またはデータ無し:-1 を返す
`int`	`read(byte[] data)` 配列に読む.
`int`	`read(byte[] data, int offset, int length)` 配列の一部に読む.
`Packet`	`readPacket(long length)` 内部的に分割を高速にしたい処理。
`int`	`size()` サイズ取得。
`long`	`skip(long size)` InputStream とあわせる.
`byte[]`	`toByteArray()` byte配列に変換する。
`String`	`toString()` for Debug.

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

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

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

- コンストラクタの詳細
  - StreamFrontPacket
```
public StreamFrontPacket(InputStream in)
```
    パラメータ:
    
    in - 入力
  - StreamFrontPacket
```
public StreamFrontPacket(Reader reader)
```
- メソッドの詳細
  - get
```
public byte get()
```
    定義:
    
    get インタフェース内 Input
  - get
```
public long get(byte[] d,
                int offset,
                int length)
```
    定義:
    
    get インタフェース内 Input
  - getInputStream
```
public InputStream getInputStream()
```
    インタフェースからコピーされた説明: Input
    
    ストリームと完全互換ではないがそれっぽくしてくれる.
    
    定義:
    
    getInputStream インタフェース内 Input
    
    戻り値:
  - getBackOutputStream
```
public OutputStream getBackOutputStream()
```
    インタフェースからコピーされた説明: RevOutput
    
    書き戻す用. Packetの頭にデータが増える. 頭に書き足す/戻すので繋ぎ方に注意.
    
    定義:
    
    getBackOutputStream インタフェース内 RevOutput
    
    戻り値:
    
    特殊用途OutputStream
  - read
```
public int read()
```
    インタフェースからコピーされた説明: Input
    
    InputStreamとの違い入力ブロックせずにデータ:0-255 またはデータ無し:-1 を返す
    
    定義:
    
    read インタフェース内 Input
    
    戻り値:
    
    -1 または 0-255
  - read
```
public int read(byte[] data,
                int offset,
                int length)
```
    インタフェースからコピーされた説明: Input
    
    配列の一部に読む. ないときはサイズ0. length と length() の小さい範囲
    
    定義:
    
    read インタフェース内 Input
    
    パラメータ:
    
    data - バッファ
    
    offset - バッファ位置
    
    length - サイズ
    
    戻り値:
    
    読めたサイズ
  - read
```
public int read(byte[] data)
```
    インタフェースからコピーされた説明: Input
    
    配列に読む. ないときはサイズ0 read(d,0,d.length) と同じ
    
    定義:
    
    read インタフェース内 Input
    
    パラメータ:
    
    data - バッファ
    
    戻り値:
    
    読めたサイズ
    
    関連項目:
    
    Input.read(byte[],int,int)
  - skip
```
public long skip(long size)
```
    インタフェースからコピーされた説明: Input
    
    InputStream とあわせる.
    
    定義:
    
    skip インタフェース内 Input
    
    パラメータ:
    
    size - skipするサイズ
    
    戻り値:
    
    skipしたサイズ
  - toByteArray
```
public byte[] toByteArray()
```
    インタフェースからコピーされた説明: Input
    
    byte配列に変換する。
    
    定義:
    
    toByteArray インタフェース内 Input
    
    戻り値:
    
    readするデータの配列
  - backWrite
```
public void backWrite(int data)
```
    インタフェースからコピーされた説明: RevOutput
    
    読み出しの手前に1バイト戻す.
    
    定義:
    
    backWrite インタフェース内 RevOutput
    
    パラメータ:
    
    data - 下位8ビットのみ
  - backWrite
```
public void backWrite(byte[] data)
```
    インタフェースからコピーされた説明: RevOutput
    
    読み出しの手前にデータを足す. OverBlock等で先頭を超えるとエラーの場合あり読んだデータを戻すのに便利.
    
    定義:
    
    backWrite インタフェース内 RevOutput
    
    パラメータ:
    
    data - データを含む配列.
  - backWrite
```
public void backWrite(byte[] data,
                      int offset,
                      int length)
```
    インタフェースからコピーされた説明: RevOutput
    
    読み出しの手前にデータを足す. 読んだデータを戻すのに便利.
    
    定義:
    
    backWrite インタフェース内 RevOutput
    
    パラメータ:
    
    data - データを含む配列.
    
    offset - 開始位置
    
    length - データ長
  - backWrite
```
public long backWrite(RevInput rin)
```
    インタフェースからコピーされた説明: RevOutput
    
    上限配慮あり. 転送元、転送先どちらかの上限まで移動する.
    
    定義:
    
    backWrite インタフェース内 RevOutput
    
    パラメータ:
    
    rin - 逆入力.
    
    戻り値:
    
    戻ったサイズ
  - backWrite
```
public long backWrite(RevInput rin,
                      long length)
```
    インタフェースからコピーされた説明: RevOutput
    
    逆書き込み
    
    定義:
    
    backWrite インタフェース内 RevOutput
    
    パラメータ:
    
    rin - 逆入力
    
    length - 長さ
    
    戻り値:
    
    戻ったサイズ
  - dbackWrite
```
public void dbackWrite(byte[] data)
```
    インタフェースからコピーされた説明: RevOutput
    
    複製しない(可能な場合)
    
    定義:
    
    dbackWrite インタフェース内 RevOutput
    
    パラメータ:
    
    data - データ列
  - flush
```
public void flush()
```
    定義:
    
    flush インタフェース内 RevOutput
  - size
```
public int size()
```
    サイズ取得。 availableしか使えないので不確定な要素.
    
    定義:
    
    size インタフェース内 Input
    
    戻り値:
  - length
```
public long length()
```
    インタフェースからコピーされた説明: Input
    
    読めるサイズ long版. 32ビットでは足りないかもと足してみた
    
    定義:
    
    length インタフェース内 Input
    
    戻り値:
    
    サイズ
  - close
```
public void close()
           throws IOException
```
    連結した入力を閉じる. Packetには特殊な要素.
    
    例外:
    
    IOException
  - readPacket
```
public Packet readPacket(long length)
```
    インタフェースからコピーされた説明: Input
    
    内部的に分割を高速にしたい処理。 position的なところから length 分をPacket にreadで読ませる程度の処理
    
    定義:
    
    readPacket インタフェース内 Input
    
    パラメータ:
    
    length - 長さ
    
    戻り値:
    
    分割したPacket
  - toString
```
public String toString()
```
    for Debug. でばっぐ用なのでてきとう
    
    オーバーライド:
    
    toString クラス内 Object
    
    戻り値:

クラス StreamFrontPacket

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

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

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

メソッドのサマリー

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

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

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

コンストラクタの詳細

StreamFrontPacket

StreamFrontPacket

メソッドの詳細

get

get

getInputStream

getBackOutputStream

read

read

read

skip

toByteArray

backWrite

backWrite

backWrite

backWrite

backWrite

dbackWrite

flush

size

length

close

readPacket

toString