com.fiverworks.xone.model
クラス XoneElementList

java.lang.Object
  拡張com.fiverworks.xone.model.XoneElementList
すべての実装インタフェース:
Cloneable

public class XoneElementList
extends Object
implements Cloneable

Xoneのエレメントリストを表すクラスです。
タイプセーフなリストで、追加したり取得できるのはXoneElementのインスタンスだけです(ただし、nullは追加できません)。スレッドセーフではありません。


コンストラクタの概要
XoneElementList(String name)
          エレメントリストの名前からXoneElementListのインスタンスを生成します。
 
メソッドの概要
 void add(int index, String name, String type)
          指定されたパラメータでエレメントを作成し、指定された位置に追加します。
 void add(int index, String name, String type, String value)
          指定されたパラメータでエレメントを作成し、指定された位置に追加します。
 void add(int index, String name, String type, String[] values)
          指定されたパラメータでエレメントを作成し、指定された位置に追加します。
 void add(int index, XoneElement element)
          指定された位置にエレメントを追加します。
 boolean add(String name, String type)
          指定されたパラメータでエレメントを作成し、リストの最後に追加します。
 boolean add(String name, String type, String value)
          指定されたパラメータでエレメントを作成し、リストの最後に追加します。
 boolean add(String name, String type, String[] values)
          指定されたパラメータでエレメントを作成し、リストの最後に追加します。
 boolean add(XoneElement element)
          リストの最後にエレメントを追加します。
 boolean addAll(int index, XoneElement[] elements)
          指定された位置に指定されたすべてのエレメントを追加します。
 boolean addAll(int index, XoneElementList elementList)
          指定された位置に指定されたすべてのエレメントを追加します。
 boolean addAll(XoneElement[] elements)
          リストの最後に指定されたすべてのエレメントを追加します。
 boolean addAll(XoneElementList elementList)
          リストの最後に指定されたすべてのエレメントを追加します。
 void clear()
          エレメントリストをクリアします。
 Object clone()
          このエレメントリストのコピーを返します。
 Object clone(String newName)
          このエレメントリストのコピーを指定した名前におきかえて返します。
 boolean contains(String name)
          エレメントリストに指定された名前のエレメントが含まれるか調べます。
 boolean contains(XoneElement element)
          エレメントリストに指定されたエレメントが含まれるか調べます。
 boolean containsAll(XoneElementList elementList)
          エレメントリストに指定されたエレメントがすべて含まれるか調べます。
 XoneElement get(int index)
          指定された位置のエレメントを取得します。
 XoneElement get(String name)
          指定された名前の最初のエレメントを取得します。
 XoneElement[] getAll()
          このエレメントリストのすべてのエレメントをエレメント配列にして返します。
 XoneElement[] getAll(String name)
          指定された名前のエレメントをすべて取得します。
 String getName()
          エレメントリストの名前を取得します。
 int indexOf(XoneElement element)
          指定されたエレメントと同じエレメントの最初にあらわれるインデックスを取得します。
 boolean isEmpty()
          このエレメントリストが空かどうかを返します。
 Iterator iterator()
          このエレメントリストのイテレータを返します。
 int lastIndexOf(XoneElement element)
          指定されたエレメントと同じエレメントの最後にあらわれるインデックスを取得します。
 ListIterator listIterator()
          このエレメントリストのリストイテレータを返します。
 ListIterator listIterator(int index)
          このエレメントリストの指定された位置から開始するリストイテレータを返します。
 XoneElement remove(int index)
          指定された位置のエレメントを削除します。
 boolean remove(String name)
          指定された名前と同じ名前の最初のエレメントを削除します。
 boolean remove(XoneElement element)
          指定されたエレメントと同じ最初のエレメントを削除します。
 boolean removeAll(String name)
          指定された名前と同じ名前のエレメントをすべて削除します。
 boolean removeAll(XoneElementList elementList)
          指定されたエレメントリストと同じエレメントを削除します。
 boolean retainAll(XoneElementList elementList)
          指定されたエレメントリストと同じエレメントだけを保持します。
 XoneElement set(int index, XoneElement element)
          指定された位置にあるエレメントを指定されたエレメントで置き換えます。
 int size()
          このエレメントリストのエレメントの個数を返します。
 XoneElementList subList(String name, int fromIndex, int toIndex)
          このエレメントリストのfromIndex (これを含む) から toIndex (これを含まない) の範囲の部分のエレメントリストを返します。
 Object[] toArray()
          このエレメントリストのすべてのエレメントをオブジェクト配列にして返します。
 Object[] toArray(Object[] array)
          このエレメントリストのすべてのエレメントをオブジェクト配列にして返します。
 String toString()
          このエレメントリストの文字列表現を返します。
 
クラス java.lang.Object から継承したメソッド
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

XoneElementList

public XoneElementList(String name)
エレメントリストの名前からXoneElementListのインスタンスを生成します。

パラメータ:
name - エレメントリストの名前
メソッドの詳細

getName

public String getName()
エレメントリストの名前を取得します。

戻り値:
エレメントリストの名前

add

public boolean add(XoneElement element)
リストの最後にエレメントを追加します。nullは追加できません。

パラメータ:
element - 追加するエレメント
戻り値:
true
例外:
XoneRuntimeException - elementがnullの場合

add

public void add(int index,
                XoneElement element)
指定された位置にエレメントを追加します。nullは追加できません。

パラメータ:
index - 追加する位置
element - 追加するエレメント
例外:
XoneRuntimeException - indexが範囲外の場合、あるいはelementがnullの場合

add

public boolean add(String name,
                   String type,
                   String value)
指定されたパラメータでエレメントを作成し、リストの最後に追加します。

パラメータ:
name - エレメント名
type - エレメントの型
value - エレメントの値
戻り値:
true
例外:
XoneRuntimeException - name,type,valueのいずれかが不正な場合

add

public void add(int index,
                String name,
                String type,
                String value)
指定されたパラメータでエレメントを作成し、指定された位置に追加します。

パラメータ:
index - 追加する位置
name - エレメント名
type - エレメントの型
value - エレメントの値
例外:
XoneRuntimeException - indexが範囲外の場合、あるいはname,type,valueのいずれかが不正な場合

add

public boolean add(String name,
                   String type)
指定されたパラメータでエレメントを作成し、リストの最後に追加します。

パラメータ:
name - エレメント名
type - エレメントの型
戻り値:
true
例外:
XoneRuntimeException - name,typeのいずれかが不正な場合

add

public void add(int index,
                String name,
                String type)
指定されたパラメータでエレメントを作成し、指定された位置に追加します。

パラメータ:
index - 追加する位置
name - エレメント名
type - エレメントの型
例外:
XoneRuntimeException - indexが範囲外の場合、あるいはname,typeのいずれかが不正な場合

add

public boolean add(String name,
                   String type,
                   String[] values)
指定されたパラメータでエレメントを作成し、リストの最後に追加します。

パラメータ:
name - エレメント名
type - エレメントの型
values - エレメントの値
戻り値:
true
例外:
XoneRuntimeException - name,type,valuesのいずれかが不正な場合

add

public void add(int index,
                String name,
                String type,
                String[] values)
指定されたパラメータでエレメントを作成し、指定された位置に追加します。

パラメータ:
index - 追加する位置
name - エレメント名
type - エレメントの型
values - エレメントの値
例外:
XoneRuntimeException - indexが範囲外の場合、あるいはname,type,valuesのいずれかが不正な場合

addAll

public boolean addAll(XoneElementList elementList)
リストの最後に指定されたすべてのエレメントを追加します。

パラメータ:
elementList - エレメントリスト
戻り値:
この呼び出しによってリストの内容が変更された場合はtrue
例外:
XoneRuntimeException - elementListの中にnullがある場合

addAll

public boolean addAll(XoneElement[] elements)
リストの最後に指定されたすべてのエレメントを追加します。

パラメータ:
elements - エレメントの配列
戻り値:
この呼び出しによってリストの内容が変更された場合はtrue
例外:
XoneRuntimeException - elementsの要素の中にnullがある場合

addAll

public boolean addAll(int index,
                      XoneElement[] elements)
指定された位置に指定されたすべてのエレメントを追加します。

パラメータ:
index - 追加する位置
elements - 追加するエレメント配列
戻り値:
この呼び出しによってリストの内容が変更された場合はtrue
例外:
XoneRuntimeException - indexが範囲外の場合、あるいはelementsの要素の中にnullがある場合

addAll

public boolean addAll(int index,
                      XoneElementList elementList)
指定された位置に指定されたすべてのエレメントを追加します。

パラメータ:
index - 追加する位置
elementList - 追加するエレメントリスト
戻り値:
この呼び出しによってリストの内容が変更された場合はtrue
例外:
XoneRuntimeException - indexが範囲外の場合、あるいはelementListの中にnullがある場合

clear

public void clear()
エレメントリストをクリアします。


contains

public boolean contains(XoneElement element)
エレメントリストに指定されたエレメントが含まれるか調べます。

パラメータ:
element - 調べるエレメント
戻り値:
含まれるときはtrue

contains

public boolean contains(String name)
エレメントリストに指定された名前のエレメントが含まれるか調べます。

パラメータ:
name - 調べる名前
戻り値:
含まれるときはtrue

containsAll

public boolean containsAll(XoneElementList elementList)
エレメントリストに指定されたエレメントがすべて含まれるか調べます。

パラメータ:
elementList - 調べるレメントリスト
戻り値:
含まれるときはtrue

get

public XoneElement get(int index)
指定された位置のエレメントを取得します。

パラメータ:
index - 取得する位置
戻り値:
取得したエレメント
例外:
XoneRuntimeException - indexが範囲外の場合

get

public XoneElement get(String name)
指定された名前の最初のエレメントを取得します。

パラメータ:
name - 取得するエレメントの名前
戻り値:
取得したエレメント(存在しない場合はnull)
例外:
XoneRuntimeException - nameが不正な場合

getAll

public XoneElement[] getAll(String name)
指定された名前のエレメントをすべて取得します。

パラメータ:
name - 取得するエレメントの名前
戻り値:
取得したエレメントの配列(存在しない場合は大きさが0の配列)
例外:
XoneRuntimeException - nameが不正な場合

indexOf

public int indexOf(XoneElement element)
指定されたエレメントと同じエレメントの最初にあらわれるインデックスを取得します。

パラメータ:
element - 調べるエレメント
戻り値:
最初にあらわれるインデックス。見つからないときは-1

isEmpty

public boolean isEmpty()
このエレメントリストが空かどうかを返します。

戻り値:
空のときはtrue

iterator

public Iterator iterator()
このエレメントリストのイテレータを返します。

戻り値:
イテレータ

lastIndexOf

public int lastIndexOf(XoneElement element)
指定されたエレメントと同じエレメントの最後にあらわれるインデックスを取得します。

パラメータ:
element - 調べるエレメント
戻り値:
最後にあらわれるインデックス。見つからないときは-1

listIterator

public ListIterator listIterator()
このエレメントリストのリストイテレータを返します。

戻り値:
リストイテレータ

listIterator

public ListIterator listIterator(int index)
このエレメントリストの指定された位置から開始するリストイテレータを返します。

パラメータ:
index - 開始する位置
戻り値:
リストイテレータ
例外:
XoneRuntimeException - indexが範囲外の場合

remove

public XoneElement remove(int index)
指定された位置のエレメントを削除します。

パラメータ:
index - 削除する位置
戻り値:
削除したエレメント
例外:
XoneRuntimeException - indexが範囲外の場合

remove

public boolean remove(XoneElement element)
指定されたエレメントと同じ最初のエレメントを削除します。

パラメータ:
element - 削除するエレメント
戻り値:
指定されたエレメントがあるときはtrue
例外:
XoneRuntimeException - elementがnullの場合

remove

public boolean remove(String name)
指定された名前と同じ名前の最初のエレメントを削除します。

パラメータ:
name - 削除するエレメント名
戻り値:
指定されたエレメントがあるときはtrue
例外:
XoneRuntimeException - nameが不正な場合

removeAll

public boolean removeAll(String name)
指定された名前と同じ名前のエレメントをすべて削除します。

パラメータ:
name - 削除するエレメント名
戻り値:
削除されたエレメントがあればtrue
例外:
XoneRuntimeException - nameが不正な場合

removeAll

public boolean removeAll(XoneElementList elementList)
指定されたエレメントリストと同じエレメントを削除します。

パラメータ:
elementList - 削除するエレメントリスト
戻り値:
削除されたエレメントがあればtrue
例外:
XoneRuntimeException - elementListの中にnullがある場合

retainAll

public boolean retainAll(XoneElementList elementList)
指定されたエレメントリストと同じエレメントだけを保持します。

パラメータ:
elementList - 保持するエレメントリスト
戻り値:
保持されたエレメントがあればtrue
例外:
XoneRuntimeException - elementListの中にnullがある場合

set

public XoneElement set(int index,
                       XoneElement element)
指定された位置にあるエレメントを指定されたエレメントで置き換えます。

パラメータ:
index - 置き換える位置
element - 置き換えるエレメント
戻り値:
指定された位置に以前あったエレメント
例外:
XoneRuntimeException - indexが範囲外の場合、あるいはelementがnullの場合

size

public int size()
このエレメントリストのエレメントの個数を返します。

戻り値:
エレメントの個数

subList

public XoneElementList subList(String name,
                               int fromIndex,
                               int toIndex)
このエレメントリストのfromIndex (これを含む) から toIndex (これを含まない) の範囲の部分のエレメントリストを返します。

パラメータ:
name - エレメントリストの名前
fromIndex - subListの下端点 (これを含む)
toIndex - subListの上端点(これを含まない)
戻り値:
指定された範囲のエレメントリスト
例外:
XoneRuntimeException - nameが不正な場合、あるいはfromIndex、toIndexの値が不正な場合

toArray

public Object[] toArray()
このエレメントリストのすべてのエレメントをオブジェクト配列にして返します。

戻り値:
オブジェクト配列

toArray

public Object[] toArray(Object[] array)
このエレメントリストのすべてのエレメントをオブジェクト配列にして返します。

パラメータ:
array - エレメントリストのエレメントの格納先の配列
戻り値:
オブジェクト配列

getAll

public XoneElement[] getAll()
このエレメントリストのすべてのエレメントをエレメント配列にして返します。

戻り値:
エレメント配列

toString

public String toString()
このエレメントリストの文字列表現を返します。

戻り値:
エレメントリストの文字列表現

clone

public Object clone()
このエレメントリストのコピーを返します。

戻り値:
コピーしたエレメントリスト

clone

public Object clone(String newName)
このエレメントリストのコピーを指定した名前におきかえて返します。

パラメータ:
newName - 新しいエレメントリストの名前
戻り値:
コピーしたエレメントリスト
例外:
XoneRuntimeException - nameが不正な場合