モジュール java.base
パッケージ java.nio

クラスShortBuffer

  • すべての実装されたインタフェース:
    Comparable<ShortBuffer>

    public abstract class ShortBuffer
extends Buffer
implements Comparable<ShortBuffer>
    shortバッファです。

    このクラスは、shortバッファに対する操作を4つのカテゴリに分類します。

    • 単一short値の読み込みと書込みを行う絶対および相対get/putメソッド。

    • 連続したshortシーケンスをこのバッファから配列へと転送する相対一括getメソッド。

    • 連続したshortシーケンスをshort配列やその他のshortバッファからこのバッファへと転送する相対一括putメソッド。

    • ショート・バッファのcompactingのメソッド。

    shortバッファを作成するには、バッファの内容に容量を割り当てる割り当てを実行するか、既存のshort配列をバッファ内にラップするか、既存のbyteバッファのビューを作成します。

    byteバッファと同様に、shortバッファにもダイレクトと非ダイレクトがあります。 このクラスのwrapメソッドで作成されたshortバッファは非ダイレクト・バッファになります。 byteバッファのビューとして作成されたshortバッファは、byteバッファがダイレクト・バッファである場合にかぎりダイレクト・バッファになります。 shortバッファがダイレクト・バッファかどうかは、isDirectメソッドの呼出しによって判断できます。

    このクラスのメソッドのうち戻り値を返さないものは、自身を呼び出したバッファの情報を返します。 これを応用して、メソッド呼出しを連鎖させることができます。

    導入されたバージョン:
    1.4

    • メソッドのサマリー

      すべてのメソッド staticメソッド インスタンス・メソッド 抽象メソッド 具象メソッド 
      修飾子と型 メソッド 説明
      static ShortBuffer allocate​(int capacity)
      新しいshortバッファを割り当てます。
      short[] array​()
      このバッファを補助するshort配列を返します  (オプションの操作)。
      int arrayOffset​()
      このバッファの補助配列内にある、このバッファの最初の要素のオフセットを返します  (オプションの操作)。
      abstract ShortBuffer asReadOnlyBuffer​()
      このバッファの内容を共有する新しい読込み専用shortバッファを作成します。
      ShortBuffer clear​()
      このバッファをクリアします。
      abstract ShortBuffer compact​()
      このバッファを圧縮します  (オプションの操作)。
      int compareTo​(ShortBuffer that)
      このバッファを別のバッファと比較します。
      abstract ShortBuffer duplicate​()
      このバッファの内容を共有する新しいshortバッファを作成します。
      boolean equals​(Object ob)
      このバッファが別のオブジェクトと等価であるかどうかを判断します。
      ShortBuffer flip​()
      このバッファをフリップ(反転)します。
      abstract short get​()
      相対getメソッドです。
      abstract short get​(int index)
      絶対getメソッドです。
      ShortBuffer get​(short[] dst)
      相対一括getメソッドです。
      ShortBuffer get​(short[] dst, int offset, int length)
      相対一括getメソッドです。
      boolean hasArray​()
      このバッファがアクセス可能なshort配列に連動するかどうかを判断します。
      int hashCode​()
      このバッファの現在のハッシュ・コードを返します。
      abstract boolean isDirect​()
      現在のshortバッファがダイレクト・バッファであるかどうかを判断します。
      ShortBuffer limit​(int newLimit)
      このバッファのリミットを設定します。
      ShortBuffer mark​()
      このバッファの現在位置にマークを設定します。
      abstract ByteOrder order​()
      このバッファのbyte順序を取得します。
      ShortBuffer position​(int newPosition)
      このバッファの位置を設定します。
      abstract ShortBuffer put​(int index, short s)
      絶対putメソッドです  (オプションの操作)。
      abstract ShortBuffer put​(short s)
      相対putメソッドです  (オプションの操作)。
      ShortBuffer put​(short[] src)
      相対一括putメソッドです  (オプションの操作)。
      ShortBuffer put​(short[] src, int offset, int length)
      相対一括putメソッドです  (オプションの操作)。
      ShortBuffer put​(ShortBuffer src)
      相対一括putメソッドです  (オプションの操作)。
      ShortBuffer reset​()
      バッファの位置を以前にマークした位置に戻します。
      ShortBuffer rewind​()
      このバッファをリワインド(巻き戻し)します。
      abstract ShortBuffer slice​()
      このバッファの内容の共有サブシーケンスを内容とする新しいshortバッファを作成します。
      String toString​()
      このバッファの状態を要約した文字列を返します。
      static ShortBuffer wrap​(short[] array)
      short配列をバッファにラップします。
      static ShortBuffer wrap​(short[] array, int offset, int length)
      short配列をバッファにラップします。

    • メソッドの詳細

      • allocate

        public static ShortBuffer allocate​(int capacity)
        新しいshortバッファを割り当てます。

        新しいバッファの位置は0になり、その限界はその容量になり、マークは未定義になり、各要素はゼロに初期化され、バイト・オーダーは基礎となるハードウェアのnative orderになります。 補助配列を持ち、配列オフセットはゼロになります。

        パラメータ:
        capacity - 新しいバッファの容量(short)
        戻り値:
        新しいshortバッファ
        例外:
        IllegalArgumentException - capacityが負の整数である場合

      • wrap

        public static ShortBuffer wrap​(short[] array,
                               int offset,
                               int length)
        short配列をバッファにラップします。

        新しいバッファは指定されたshort配列によって補助されます。バッファに変更を加えると配列も変更され、配列に変更を加えるとバッファも変更されます。 新しいバッファの容量はarray.lengthになり、その位置はoffsetになり、その制限はoffset + lengthになり、そのマークは未定義となり、そのバイト順序は基盤となるハードウェアのnative orderになります。 指定された配列が補助配列となり、その配列オフセットはゼロになります。

        パラメータ:
        array - 新しいバッファを補助する配列
        offset -使用するサブ配列のオフセット。array.length以下の負でない値でなければならない。 新しいバッファの位置は、この値に設定される。
        length - 使用するサブ配列の長さ。array.length - offset以下の負でない値でなければならない。 新しいバッファのリミットは、offset+lengthに設定される。
        戻り値:
        新しいshortバッファ
        例外:
        IndexOutOfBoundsException - offsetパラメータとlengthパラメータの前提条件が満たされていない場合

      • wrap

        public static ShortBuffer wrap​(short[] array)
        short配列をバッファにラップします。

        新しいバッファは指定されたshort配列によって補助されます。バッファに変更を加えると配列も変更され、配列に変更を加えるとバッファも変更されます。 新しいバッファの容量と限界はarray.lengthになり、その位置はゼロになり、マークは未定義になり、そのバイト・オーダーは基盤となるハードウェアのnative orderになります。 指定された配列が補助配列となり、その配列オフセットはゼロになります。

        パラメータ:
        array - このバッファを補助する配列
        戻り値:
        新しいshortバッファ

      • slice

        public abstract ShortBuffer slice​()
        このバッファの内容の共有サブシーケンスを内容とする新しいshortバッファを作成します。

        新しいバッファの内容は、このバッファの現在位置から始まります。 このバッファの内容に変更を加えると、その内容が新しいバッファに反映されます。新しいバッファの内容に変更を加えると、その内容がこのバッファに反映されます。2つのバッファの位置、リミット、マークの値はそれぞれ異なります。

        新しいバッファの位置はゼロになり、その容量と限界はこのバッファに残っているshortの数になり、そのマークは未定義になり、そのバイト順序はこのバッファの順序と同じになります。 新しいバッファは、このバッファがダイレクト・バッファである場合にかぎりダイレクト・バッファになります。また、このバッファが読取り専用バッファである場合にかぎり読取り専用バッファになります。

        定義:
        クラスBufferのslice
        戻り値:
        新しいshortバッファ

      • duplicate

        public abstract ShortBuffer duplicate​()
        このバッファの内容を共有する新しいshortバッファを作成します。

        新しいバッファの内容は、このバッファの内容と同じになります。 このバッファの内容に変更を加えると、その内容が新しいバッファに反映されます。新しいバッファの内容に変更を加えると、その内容がこのバッファに反映されます。2つのバッファの位置、リミット、マークの値はそれぞれ異なります。

        新しいバッファ容量、限界、位置、マーク値、およびバイト順は、このバッファのものと同じになります。 新しいバッファは、このバッファがダイレクト・バッファである場合にかぎりダイレクト・バッファになります。また、このバッファが読取り専用バッファである場合にかぎり読取り専用バッファになります。

        定義:
        クラスBufferのduplicate
        戻り値:
        新しいshortバッファ

      • asReadOnlyBuffer

        public abstract ShortBuffer asReadOnlyBuffer​()
        このバッファの内容を共有する新しい読込み専用shortバッファを作成します。

        新しいバッファの内容は、このバッファの内容と同じになります。 このバッファの内容に変更を加えると、その内容が新しいバッファに反映されます。しかし、新しいバッファ自体は読取り専用であり、その共有内容を変更することはできません。 2つのバッファの位置、リミット、マークの値はそれぞれ異なります。

        新しいバッファ容量、限界、位置、マーク値、およびバイト順は、このバッファのものと同じになります。

        このバッファ自身が読込み専用の場合は、このメソッドはduplicateと同じように動作します。

        戻り値:
        新しい読込み専用shortバッファ

      • get

        public abstract short get​()
        相対getメソッドです。 このバッファの現在位置のshortを読み込み、現在位置を増加します。
        戻り値:
        バッファの現在位置のshort
        例外:
        BufferUnderflowException - バッファの現在位置がリミット以上である場合

      • put

        public abstract ShortBuffer put​(short s)
        相対putメソッドです  (オプションの操作)。

        このバッファの現在位置に指定されたshortを書き込み、現在位置を増加します。

        パラメータ:
        s - 書き込まれるshort
        戻り値:
        このバッファ
        例外:
        BufferOverflowException - このバッファの現在位置がリミット以上である場合
        ReadOnlyBufferException - このバッファが読込み専用である場合

      • get

        public abstract short get​(int index)
        絶対getメソッドです。 指定されたインデックス位置のshortを読み込みます。
        パラメータ:
        index - shortの読込み位置を示すインデックス
        戻り値:
        指定されたインデックス位置のshort
        例外:
        IndexOutOfBoundsException - indexが負の数である場合、またはバッファのリミット以上である場合

      • put

        public abstract ShortBuffer put​(int index,
                                short s)
        絶対putメソッドです  (オプションの操作)。

        このバッファの指定されたインデックス位置に指定されたshortを書き込みます。

        パラメータ:
        index - shortの書込み先を示すインデックス
        s - 書き込まれるshort値
        戻り値:
        このバッファ
        例外:
        IndexOutOfBoundsException - indexが負の数である場合、またはバッファのリミット以上である場合
        ReadOnlyBufferException - このバッファが読込み専用である場合

      • get

        public ShortBuffer get​(short[] dst,
                       int offset,
                       int length)
        相対一括getメソッドです。

        このメソッドは、このバッファから指定された配列へshortを転送します。 このバッファ内に残っているshort数が要求に満たない場合(つまり、length > remaining()である場合)、shortは一切転送されず、BufferUnderflowExceptionがスローされます。

        それ以外の場合、このメソッドは、length個のshortを、このバッファの現在位置から指定された配列の指定されたオフセット位置へコピーします。 そのたびに、このバッファの位置がlengthずつ増加します。

        このメソッドをsrc.get(dst, off, len)の形式で呼び出すと、次のループとまったく同じ結果になります。 

        
     for (int i = off; i < off + len; i++)
         dst[i] = src.get():
        ただし、このバッファ内に十分な数のshortが存在することを最初に確認する動作は除きます。また、このメソッドを使用したほうがループよりもはるかに効率的です。
        パラメータ:
        dst - shortの書込み先となる配列
        offset - 最初のshortの書込み先となる配列内のオフセット。dst.length以下の負でない値でなければならない
        length - 指定された配列に書き込まれるshortの最大数。dst.length - offset以下の負でない値でなければならない
        戻り値:
        このバッファ
        例外:
        BufferUnderflowException - このバッファ内に残っているshort数がlengthよりも少ない場合
        IndexOutOfBoundsException - offsetパラメータとlengthパラメータの前提条件が満たされていない場合

      • get

        public ShortBuffer get​(short[] dst)
        相対一括getメソッドです。

        このメソッドは、このバッファから指定された配列へshortを転送します。 このメソッドをsrc.get(a)の形式で呼び出すと、次の呼び出しと同じ結果になります。 

             src.get(a, 0, a.length)
        パラメータ:
        dst - コピー先配列
        戻り値:
        このバッファ
        例外:
        BufferUnderflowException - このバッファ内に残っているshort数がlengthよりも少ない場合

      • put

        public ShortBuffer put​(ShortBuffer src)
        相対一括putメソッドです  (オプションの操作)。

        このメソッドは、指定されたソース・バッファ内に残っているshortをこのバッファへ転送します。 ソース・バッファ内に残っているshort数がこのバッファ内に残っているshort数よりも多い場合(つまり、src.remaining() > remaining()である場合)、shortは一切転送されず、BufferOverflowExceptionがスローされます。

        それ以外の場合、このメソッドは、指定されたバッファの現在位置からこのバッファの現在位置へn = src.remaining()個のshortをコピーします。 そのたびに、両方のバッファの位置がnずつ増加します。

        このメソッドをdst.put(src)の形式で呼び出すと、次のループとまったく同じ結果になります。 

             while (src.hasRemaining())
         dst.put(src.get());
        ただし、このバッファ内に十分な容量があることを最初に確認する動作は除きます。また、このメソッドを使用したほうがループよりもはるかに効率的です。
        パラメータ:
        src - shortの読込み先となるソース・バッファ(このバッファ以外)
        戻り値:
        このバッファ
        例外:
        BufferOverflowException - このバッファに、ソース・バッファ内に残っているshortを格納できるだけの容量がない場合
        IllegalArgumentException - ソース・バッファとしてこのバッファを指定した場合
        ReadOnlyBufferException - このバッファが読込み専用である場合

      • put

        public ShortBuffer put​(short[] src,
                       int offset,
                       int length)
        相対一括putメソッドです  (オプションの操作)。

        このメソッドは、指定されたソース配列からこのバッファへshortを転送します。 配列からコピーするshort数がこのバッファ内に残っているshort数より多い場合(つまり、length > remaining()である場合)、shortは一切転送されず、BufferOverflowExceptionがスローされます。

        それ以外の場合、このメソッドは、指定された配列の指定されたオフセット位置からこのバッファの現在位置へlength個のshortをコピーします。 そのたびに、このバッファの位置がlengthずつ増加します。

        このメソッドをdst.put(src, off, len)の形式で呼び出すと、次のループとまったく同じ結果になります。 

        
     for (int i = off; i < off + len; i++)
         dst.put(a[i]);
        ただし、このバッファ内に十分な容量があることを最初に確認する動作は除きます。また、このメソッドを使用したほうがループよりもはるかに効率的です。
        パラメータ:
        src - shortの読込み先となる配列
        offset - 最初のshortの読込み先となる配列内のオフセット。array.length以下の負でない値にする必要がある
        length - 指定された配列から読み取られるshortの数。array.length - offset以下の負でない値でなければならない
        戻り値:
        このバッファ
        例外:
        BufferOverflowException - このバッファ内に残っている容量が不足している場合
        IndexOutOfBoundsException - offsetパラメータとlengthパラメータの前提条件が満たされていない場合
        ReadOnlyBufferException - このバッファが読込み専用である場合

      • put

        public final ShortBuffer put​(short[] src)
        相対一括putメソッドです  (オプションの操作)。

        このメソッドは、ソースとなる指定されたshort配列の内容全体をこのバッファへ転送します。 このメソッドをdst.put(a)の形式で呼び出すと、次の呼び出しと同じ結果になります。 

             dst.put(a, 0, a.length)
        パラメータ:
        src - 転送元配列
        戻り値:
        このバッファ
        例外:
        BufferOverflowException - このバッファ内に残っている容量が不足している場合
        ReadOnlyBufferException - このバッファが読込み専用である場合

      • hasArray

        public final boolean hasArray​()
        このバッファがアクセス可能なshort配列に連動するかどうかを判断します。

        このメソッドの戻り値がtrueであれば、arrayおよびarrayOffsetメソッドを安全に呼び出すことができます。

        定義:
        hasArray、クラス: Buffer
        戻り値:
        このバッファが配列に連動しており、読取り専用でない場合にかぎりtrue

      • array

        public final short[] array​()
        このバッファを補助するshort配列を返します  (オプションの操作)。

        このバッファの内容に変更を加えると、返される配列の内容も変更されます。その逆も同様です。

        このメソッドを呼び出す前にhasArrayメソッドを呼び出し、このバッファがアクセス可能な補助配列を持っていることを確認します。

        定義:
        array、クラス: Buffer
        戻り値:
        このバッファを補助する配列
        例外:
        ReadOnlyBufferException - このバッファが配列に連動しており、しかも読込み専用である場合
        UnsupportedOperationException - このバッファがアクセス可能な配列を利用しない場合

      • arrayOffset

        public final int arrayOffset​()
        このバッファの補助配列内にある、このバッファの最初の要素のオフセットを返します  (オプションの操作)。

        このバッファが配列に連動していれば、その位置pが配列のインデックスp + arrayOffset()と一致します。

        このメソッドを呼び出す前にhasArrayメソッドを呼び出し、このバッファがアクセス可能な補助配列を持っていることを確認します。

        定義:
        arrayOffset、クラス: Buffer
        戻り値:
        このバッファの配列内にある、このバッファの最初の要素のオフセット
        例外:
        ReadOnlyBufferException - このバッファが配列に連動しており、しかも読込み専用である場合
        UnsupportedOperationException - このバッファがアクセス可能な配列を利用しない場合

      • position

        public final ShortBuffer position​(int newPosition)
        このバッファの位置を設定します。 新しい位置の値よりもマークの値のほうが大きい場合、マークの定義は破棄されます。
        オーバーライド:
        クラスBufferのposition
        パラメータ:
        newPosition - 新しい位置の値は、現在のリミット以下の負でない値でなければならない
        戻り値:
        このバッファ

      • limit

        public final ShortBuffer limit​(int newLimit)
        このバッファのリミットを設定します。 位置の値が新しいリミットより大きい場合、リミットと同じ値に変更されます。 マークの値が新しいリミットより大きい場合、マークの定義は破棄されます。
        オーバーライド:
        クラスBufferのlimit
        パラメータ:
        newLimit - 新しいリミット値は、このバッファの容量以下の負でない値でなければならない
        戻り値:
        このバッファ

      • mark

        public final ShortBuffer mark​()
        このバッファの現在位置にマークを設定します。
        オーバーライド:
        クラスBufferのmark
        戻り値:
        このバッファ

      • reset

        public final ShortBuffer reset​()
        バッファの位置を以前にマークした位置に戻します。

        このメソッドを呼び出しても、マークの値は変更されません。マークが破棄されることもありません。

        オーバーライド:
        クラスBufferのreset
        戻り値:
        このバッファ

      • clear

        public final ShortBuffer clear​()
        このバッファをクリアします。 バッファの位置はゼロ、リミットは容量の値に設定されます。マークは破棄されます。

        一連のチャネル読込み操作またはput操作を使用してこのバッファにデータを格納する前に、このメソッドを呼び出します。 次に例を示します。 

         buf.clear();     // Prepare buffer for reading
 in.read(buf);    // Read data

        このメソッドはバッファ内のデータを実際に消去するわけではありません。しかし、そうした状況で使用されるため、クリアと命名されています。

        オーバーライド:
        クラスBufferのclear
        戻り値:
        このバッファ

      • flip

        public final ShortBuffer flip​()
        このバッファをフリップ(反転)します。 リミットは現在位置の値に設定され、現在位置を表す値はゼロに設定されます。 マークが定義されている場合、そのマークは破棄されます。

        一連のチャネル読込み操作(put)のあと、このメソッドを呼び出してチャネル書込み操作(相対get)の準備を行います。 次に例を示します。 

         buf.put(magic);    // Prepend header
 in.read(buf);      // Read data into rest of buffer
 buf.flip();        // Flip buffer
 out.write(buf);    // Write header + data to channel

        ある場所から別の場所にデータを転送する際、このメソッドをcompactメソッドと組み合わせて使用することがあります。

        オーバーライド:
        クラスBufferのflip
        戻り値:
        このバッファ

      • rewind

        public final ShortBuffer rewind​()
        このバッファをリワインド(巻き戻し)します。 位置はゼロに設定され、マークは破棄されます。

        このメソッドは、リミットを正しく設定したあと、一連のチャネル書込み操作(get)の前に呼び出します。 次に例を示します。 

         out.write(buf);    // Write remaining data
 buf.rewind();      // Rewind buffer
 buf.get(array);    // Copy data into array
        オーバーライド:
        クラスBufferのrewind
        戻り値:
        このバッファ

      • compact

        public abstract ShortBuffer compact​()
        このバッファを圧縮します  (オプションの操作)。

        バッファの現在位置からリミットまでの間にshortが存在する場合、これらをバッファの先頭にコピーします。 つまり、インデックス位置p = position()のshortがインデックス・ゼロにコピーされ、インデックス位置p + 1のshortがインデックス1にコピーされるということです。インデックス位置limit() - 1のshortがインデックスn = limit() - 1 - pにコピーされるまで、同様の処理が繰り返されます。 最終的にバッファの位置はn+1に設定され、リミットは容量の値と等しくなります。 マークは破棄されます。

        バッファの位置は、ゼロではなく、コピーされるshortの数と等しくなります。したがって、このメソッドを呼び出したあと、すぐに別の相対「put」メソッドを呼び出すことができます。

        戻り値:
        このバッファ
        例外:
        ReadOnlyBufferException - このバッファが読込み専用である場合

      • isDirect

        public abstract boolean isDirect​()
        現在のshortバッファがダイレクト・バッファであるかどうかを判断します。
        定義:
        isDirect、クラス: Buffer
        戻り値:
        このバッファがダイレクト・バッファである場合にかぎりtrue

      • toString

        public String toString​()
        このバッファの状態を要約した文字列を返します。
        オーバーライド:
        toString、クラス: Object
        戻り値:
        サマリー文字列

      • hashCode

        public int hashCode​()
        このバッファの現在のハッシュ・コードを返します。

        shortバッファのハッシュ・コードは、バッファ内に残っている要素、すなわちposition()からlimit() - 1までの要素のみに依存します。

        バッファのハッシュ・コードは内容依存型です。今後バッファの内容が変更されないことが明らかでないかぎり、バッファをハッシュ・マップその他のデータ構造のキーとして使用することは避けてください。

        オーバーライド:
        hashCode、クラス: Object
        戻り値:
        このバッファの現在のハッシュ・コード
        関連項目:
        Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

      • equals

        public boolean equals​(Object ob)
        このバッファが別のオブジェクトと等価であるかどうかを判断します。

        2つのshortバッファは、次の場合にかぎり等価です。

        1. 要素の型が同じである

        2. バッファ内に残っている要素数が同じである

        3. バッファ内に残っている要素のシーケンス(開始位置とは無関係)が各点で等しい(pointwise equal)

        shortバッファが、その他の型のオブジェクトと等価になることはありません。

        オーバーライド:
        equals、クラス: Object
        パラメータ:
        ob - このバッファと比較するオブジェクト
        戻り値:
        このバッファが指定されたオブジェクトと等価である場合にかぎりtrue
        関連項目:
        Object.hashCode()、HashMap

      • compareTo

        public int compareTo​(ShortBuffer that)
        このバッファを別のバッファと比較します。

        2つのshortバッファを比較する際は、バッファ内に残っている要素のシーケンスが辞書順に比較されます。このとき、双方のバッファ内に残っているシーケンスの開始位置は考慮されません。 Short.compare(short,short)を呼び出したかのように、short要素のペアが比較されます。

        shortバッファとその他の型のオブジェクトを比較することはできません。

        定義:
        compareTo、インタフェース: Comparable<ShortBuffer>
        パラメータ:
        that - 比較対象のオブジェクト。
        戻り値:
        このバッファが指定されたバッファより小さい場合は負の整数、等しい場合はゼロ、大きい場合は正の整数

      • order

        public abstract ByteOrder order​()
        このバッファのbyte順序を取得します。

        割り当てまたは既存のshort配列のラップによって作成されたshortバッファのbyte順序は、基礎となるハードウェアのネイティブ順序と同じになります。 byteバッファのビューとして作成されたshortバッファのbyte順序は、ビューを作成した時点のbyteバッファのbyte順序と同じになります。

        戻り値:
        このバッファのbyte順序