Segment (Java Platform SE 7)

java.lang.Object
- javax.swing.text.Segment

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

CharSequence, Cloneable, CharacterIterator
```
public class Segment
extends Object
implements Cloneable, CharacterIterator, CharSequence
```
テキストのフラグメントを表す文字配列のセグメントです。配列に直接アクセスできても、セグメントを変更しないでください。文字をコピーするオーバーヘッドのない、テキストのフラグメントに速くアクセスできます。事実上、保護されていない文字列です。
Segment は、テキストを文字列にコピーせずに国際化 (i18n) サポートの使用を提供するために java.text.CharacterIterator インタフェースを実装します。

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`char[]`	`array` 処理対象のテキストを含む配列です。
`int`	`count` 処理対象のテキストを構成する配列要素の数です。
`int`	`offset` 目的のテキストが始まる配列へのオフセットです。

インタフェース java.text.CharacterIterator から継承されたフィールド
DONE

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

コンストラクタ
コンストラクタと説明
`Segment()` 新しいセグメントを作成します。
`Segment(char[] array, int offset, int count)` 既存の配列を参照する新しいセグメントを作成します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`char`	`charAt(int index)` 指定されたインデックスの `char` 値を返します。
`Object`	`clone()` シャローコピーを作成します。
`char`	`current()` 現在位置 (getIndex() によって返される位置) にある文字を取得します。
`char`	`first()` 位置を getBeginIndex() に設定して、その位置にある文字を返します。
`int`	`getBeginIndex()` テキストの開始インデックスを返します。
`int`	`getEndIndex()` テキストの終了インデックスを返します。
`int`	`getIndex()` 現在のインデックスを返します。
`boolean`	`isPartialReturn()` 部分的戻り値が有効であることを表すフラグです。
`char`	`last()` 位置を getEndIndex()-1 (テキストが空の場合は getEndIndex()) に設定して、その位置にある文字を返します。
`int`	`length()` この文字シーケンスの長さを返します。
`char`	`next()` イテレータのインデックスを 1 増やし、新しいインデックスにある文字を返します。
`char`	`previous()` イテレータのインデックスを 1 減らし、新しいインデックスにある文字を返します。
`char`	`setIndex(int position)` 位置を指定されたテキストの位置に設定して、その文字を返します。
`void`	`setPartialReturn(boolean p)` 部分的戻り値が有効であることを表すフラグです。
`CharSequence`	`subSequence(int start, int end)` このシーケンスのサブシーケンスである新規 `CharSequence` を返します。
`String`	`toString()` セグメントを文字列に変換します。

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

- フィールドの詳細
  - array
```
public char[] array
```
    処理対象のテキストを含む配列です。この配列は変更しないでください。効率を向上させるためだけに使用されます。
  - offset
```
public int offset
```
    目的のテキストが始まる配列へのオフセットです。
  - count
```
public int count
```
    処理対象のテキストを構成する配列要素の数です。
- コンストラクタの詳細
  - Segment
```
public Segment()
```
    新しいセグメントを作成します。
  - Segment
```
public Segment(char[] array,
       int offset,
       int count)
```
    既存の配列を参照する新しいセグメントを作成します。
    
    パラメータ:
    array - 参照する配列
    offset - 配列へのオフセット
    count - 文字数
- メソッドの詳細
  - setPartialReturn
```
public void setPartialReturn(boolean p)
```
    部分的戻り値が有効であることを表すフラグです。フラグが true の場合、インタフェースメソッド Document.getText(position,length,Segment) の実装では、コピーを作らずに可能な限り多くのテキストが返されます。フラグのデフォルトの状態は false で、Document.getText(position,length,Segment) に常に同じ戻り動作を行わせます。これは要求によってテキストを複製する場合としない場合があります。
    
    パラメータ:
    p - 部分的戻り値が有効かどうか。
    導入されたバージョン:
    
    1.4
  - isPartialReturn
```
public boolean isPartialReturn()
```
    部分的戻り値が有効であることを表すフラグです。
    
    戻り値:
    部分的戻り値が有効かどうか。
    導入されたバージョン:
    
    1.4
  - toString
```
public String toString()
```
    セグメントを文字列に変換します。
    
    定義:
    
    toString、インタフェース: CharSequence
    
    オーバーライド:
    
    toString、クラス: Object
    
    戻り値:
    文字列
  - first
```
public char first()
```
    位置を getBeginIndex() に設定して、その位置にある文字を返します。
    
    定義:
    
    first、インタフェース: CharacterIterator
    
    戻り値:
    テキスト内の先頭文字。テキストが空の場合は DONE
    導入されたバージョン:
    
    1.3
    
    関連項目:
    getBeginIndex()
  - last
```
public char last()
```
    位置を getEndIndex()-1 (テキストが空の場合は getEndIndex()) に設定して、その位置にある文字を返します。
    
    定義:
    
    last、インタフェース: CharacterIterator
    
    戻り値:
    テキスト内の最後の文字。テキストが空の場合は DONE
    導入されたバージョン:
    
    1.3
    
    関連項目:
    getEndIndex()
  - current
```
public char current()
```
    現在位置 (getIndex() によって返される位置) にある文字を取得します。
    
    定義:
    
    current、インタフェース: CharacterIterator
    
    戻り値:
    現在位置にある文字。現在位置がテキストの終わりを過ぎている場合は DONE。
    導入されたバージョン:
    
    1.3
    
    関連項目:
    getIndex()
  - next
```
public char next()
```
    イテレータのインデックスを 1 増やし、新しいインデックスにある文字を返します。結果のインデックスが getEndIndex() より大きいか、それに等しい場合、現在のインデックスが getEndIndex() にリセットされ、値 DONE が返されます。
    
    定義:
    
    next、インタフェース: CharacterIterator
    
    戻り値:
    新しい位置にある文字。新しい位置がテキスト範囲の終わりを過ぎている場合は DONE。
    導入されたバージョン:
    
    1.3
  - previous
```
public char previous()
```
    イテレータのインデックスを 1 減らし、新しいインデックスにある文字を返します。現在のインデックスが getBeginIndex() の場合、インデックスは getBeginIndex() のまま変わらず、値 DONE が返されます。
    
    定義:
    
    previous、インタフェース: CharacterIterator
    
    戻り値:
    新しい位置にある文字。現在の位置が getBeginIndex() に等しい場合は DONE。
    導入されたバージョン:
    
    1.3
  - setIndex
```
public char setIndex(int position)
```
    位置を指定されたテキストの位置に設定して、その文字を返します。
    
    定義:
    
    setIndex、インタフェース: CharacterIterator
    
    パラメータ:
    position - テキスト内の位置。有効な値は、getBeginIndex() から getEndIndex()。無効な値を指定すると、IllegalArgumentException がスローされる。
    
    戻り値:
    指定された位置にある文字。指定された位置が getEndIndex() に等しい場合は DONE
    導入されたバージョン:
    
    1.3
  - getBeginIndex
```
public int getBeginIndex()
```
    テキストの開始インデックスを返します。
    
    定義:
    
    getBeginIndex、インタフェース: CharacterIterator
    
    戻り値:
    テキストが始まる位置のインデックス。
    導入されたバージョン:
    
    1.3
  - getEndIndex
```
public int getEndIndex()
```
    テキストの終了インデックスを返します。このインデックスは、テキストの終わりの次の文字のインデックスです。
    
    定義:
    
    getEndIndex、インタフェース: CharacterIterator
    
    戻り値:
    テキスト内の最後の文字の次のインデックス
    導入されたバージョン:
    
    1.3
  - getIndex
```
public int getIndex()
```
    現在のインデックスを返します。
    
    定義:
    
    getIndex、インタフェース: CharacterIterator
    
    戻り値:
    現在のインデックス。
    導入されたバージョン:
    
    1.3
  - charAt
```
public char charAt(int index)
```
    指定されたインデックスの char 値を返します。インデックスは、0 から length() - 1 の範囲になります。配列のインデックス付けの場合と同じように、シーケンスの最初の char のインデックスは 0、次の文字のインデックスは 1 と続きます。
    
    インデックスで指定された char 値がサロゲートの場合、サロゲート値が返されます。
    
    定義:
    
    charAt、インタフェース: CharSequence
    
    パラメータ:
    index - 返される char 値のインデックス
    
    戻り値:
    指定された char 値
    導入されたバージョン:
    
    1.6
  - length
```
public int length()
```
    この文字シーケンスの長さを返します。長さはシーケンス内の 16 ビット char の数に等しくなります。
    
    定義:
    
    length、インタフェース: CharSequence
    
    戻り値:
    このシーケンスの char の数
    導入されたバージョン:
    
    1.6
  - subSequence
```
public CharSequence subSequence(int start,
                       int end)
```
    このシーケンスのサブシーケンスである新規 CharSequence を返します。サブシーケンスは、指定されたインデックスの char 値で始まり、インデックス end - 1 の char 値で終わります。返される (char の) シーケンスの長さは end - start です。このため、start == end の場合、空のシーケンスが返されます。
    
    定義:
    
    subSequence、インタフェース: CharSequence
    
    パラメータ:
    start - 開始インデックス (この値を含む)
    end - 終了インデックス (この値を含まない)
    
    戻り値:
    指定されたサブシーケンス
    導入されたバージョン:
    
    1.6
  - clone
```
public Object clone()
```
    シャローコピーを作成します。
    
    定義:
    
    clone、インタフェース: CharacterIterator
    
    オーバーライド:
    
    clone、クラス: Object
    
    戻り値:
    コピー
    関連項目:
    Cloneable

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス Segment

フィールドのサマリー

インタフェース java.text.CharacterIterator から継承されたフィールド

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

メソッドのサマリー

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

フィールドの詳細

array

offset

count

コンストラクタの詳細

Segment

Segment

メソッドの詳細

setPartialReturn

isPartialReturn

toString

first

last

current

next

previous

setIndex

getBeginIndex

getEndIndex

getIndex

charAt

length

subSequence

clone