jp.morpho.webapp
クラス FrameworkContext

java.lang.Object
  |
  +--java.util.AbstractCollection
        |
        +--java.util.AbstractList
              |
              +--java.util.Vector
                    |
                    +--jp.morpho.webapp.FrameworkContext
すべての実装インタフェース:
java.lang.Cloneable, java.util.Collection, LifeCycle, java.util.List, java.util.RandomAccess, java.io.Serializable

public class FrameworkContext
extends java.util.Vector
implements LifeCycle, java.io.Serializable

FrameworkContext クラスはプラグインを格納します。 プラグイン は add メソッドを使用して FrameworkContext に格納できます。

Web アプリケーション単位で見た場合、「サーブレットコンテキスト」 1 つに、1 つの FrameworkContext が対応します。

作成者:
Kenichi Fukuda
関連項目:
直列化された形式

フィールドの概要
 
クラス java.util.Vector から継承したフィールド
capacityIncrement, elementCount, elementData
 
クラス java.util.AbstractList から継承したフィールド
modCount
 
コンストラクタの概要
protected FrameworkContext()
           FrameworkContext を作成します。
 
メソッドの概要
 void add(int index, java.lang.Object element)
           FrameworkContext 内の指定された位置に指定のプラグインを挿入します。
 boolean add(java.lang.Object element)
           FrameworkContext の末尾に指定のプラグインを追加します。
 boolean addAll(java.util.Collection c)
           指定された Collection 内のすべてのプラグインをこの FrameworkContext の末尾に、その Collection の Iterator によって返される順序で追加します。
 boolean addAll(int index, java.util.Collection c)
           指定された Collection 内のすべてのプラグインを、FrameworkContext の指定された位置に挿入します。
 void addElement(java.lang.Object element)
           指定のプラグインを FrameworkContext の最後に追加し、サイズを 1 増やします。
 void clear()
           すべてのプラグインを FrameworkContext から削除します。
 java.lang.Object get(java.lang.String key)
           指定されたキーのプラグインを返します。
static FrameworkContext getInstance(javax.servlet.ServletContext sc)
           FrameworkContext を作成または取得します。
 void insertElementAt(java.lang.Object element, int index)
           FrameworkContext の指定された index に、指定されたプラグインを挿入します。
 boolean isRunning()
           FrameworkContext がスタートしている場合に true を返します。
 java.lang.Object remove(int index)
           FrameworkContext 内の指定の位置にあるプラグインを削除します。
 boolean remove(java.lang.Object element)
           FrameworkContext 内で最初に検出された指定のプラグインを削除します。
 boolean removeAll(java.util.Collection c)
           FrameworkContext から、指定された Collection 内に保持されているすべてのプラグインを削除します。
 void removeAllElements()
           FrameworkContext からすべてのプラグインを削除し、サイズを 0 に設定します。
 boolean removeElement(java.lang.Object element)
           最初に検出された (最小インデックスの) 引数のプラグインを FrameworkContext から削除します。
 void removeElementAt(int index)
           指定されたインデックスのプラグインを削除します。
 boolean retainAll(java.util.Collection c)
           指定された Collection 内に保持されている、FrameworkContext 内のプラグインだけを保持します。
 java.lang.Object set(int index, java.lang.Object element)
           FrameworkContext 内の指定された位置にあるプラグインを、指定のプラグインで置き換えます。
 void setElementAt(java.lang.Object element, int index)
           FrameworkContext の指定された index のプラグインに、指定されたプラグインを設定します。
 void start()
           FrameworkContext をスタートします。
 void stop()
           FrameworkContext をストップします。
 
クラス java.util.Vector から継承したメソッド
capacity, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, isEmpty, lastElement, lastIndexOf, lastIndexOf, removeRange, setSize, size, subList, toArray, toArray, toString, trimToSize
 
クラス java.util.AbstractList から継承したメソッド
iterator, listIterator, listIterator
 
クラス java.lang.Object から継承したメソッド
finalize, getClass, notify, notifyAll, wait, wait, wait
 
インタフェース java.util.List から継承したメソッド
iterator, listIterator, listIterator
 

コンストラクタの詳細

FrameworkContext

protected FrameworkContext()

FrameworkContext を作成します。

メソッドの詳細

getInstance

public static FrameworkContext getInstance(javax.servlet.ServletContext sc)
                                    throws FrameworkException

FrameworkContext を作成または取得します。 すでに FrameworkContext が作成されている場合は、それが返されます。 そうでない場合は、新しい FrameworkContext が作成されます。

新しい FrameworkContext が作成される場合、そのフレームワークコンフィグはサーブレットコンテキストの属性 jp.morpho.webapp.FrameworkContext にバインドされます。 すでにサーブレットコンテキストの属性 jp.morpho.webapp.FrameworkContext に FrameworkContext がバインドされている場合は、それが返されます。

パラメータ:
sc - この FrameworkContext を格納するサーブレットコンテキスト
戻り値:
FrameworkContext オブジェクト
FrameworkException

add

public void add(int index,
                java.lang.Object element)

FrameworkContext 内の指定された位置に指定のプラグインを挿入します。 その位置とそれ以降にプラグインがあればそれらを右に移動させ、各プラグインのインデックスに 1 を加えます。

定義:
インタフェース java.util.List 内の add
オーバーライド:
クラス java.util.Vector 内の add
パラメータ:
index - 指定のプラグインが挿入されるインデックス
element - 挿入されるプラグイン
例外:
java.lang.IndexOutOfBoundsException - インデックスが範囲外の場合 (index < 0 || index > size())
java.lang.IllegalArgumentException - 指定されたオブジェクトがプラグインでない場合、または同じ名前のプラグインが FrameworkContext にあった場合
関連項目:
List.add(int, Object)

add

public boolean add(java.lang.Object element)

FrameworkContext の末尾に指定のプラグインを追加します。

定義:
インタフェース java.util.List 内の add
オーバーライド:
クラス java.util.Vector 内の add
パラメータ:
element - FrameworkContext に追加されるプラグイン
戻り値:
true (Collection.add の汎用規約どおり)
例外:
java.lang.IllegalArgumentException - 指定されたオブジェクトがプラグインでない場合、または同じ名前のプラグインが FrameworkContext にあった場合
関連項目:
Collection.add(Object)

addAll

public boolean addAll(java.util.Collection c)

指定された Collection 内のすべてのプラグインをこの FrameworkContext の末尾に、その Collection の Iterator によって返される順序で追加します。 このオペレーションの動作は、指定された Collection がオペレーションの進行時に変更されると定義されません。 これは、その Collection が FrameworkContext である場合にこの呼び出しの動作が定義されず、FrameworkContext が空でないことを示します。

定義:
インタフェース java.util.List 内の addAll
オーバーライド:
クラス java.util.Vector 内の addAll
パラメータ:
c - FrameworkContext に挿入されるプラグイン
戻り値:
この呼び出しの結果、この FrameworkContext が変更された場合は true
例外:
java.lang.IndexOutOfBoundsException - インデックスが範囲外の場合 (index < 0 || index > size())
java.lang.NullPointerException - 指定されたコレクションが null である場合
java.lang.IllegalArgumentException - 指定されたコレクションの要素がプラグインでない場合、または同じ名前のプラグインが FrameworkContext にあった場合
関連項目:
Collection.addAll(Collection)

addAll

public boolean addAll(int index,
                      java.util.Collection c)

指定された Collection 内のすべてのプラグインを、FrameworkContext の指定された位置に挿入します。 その位置とそれ以降にプラグインがある場合は、それらを右に移動して、各プラグインのインデックスに 1 を加えます。 新しい各プラグインは、指定された Collection の反復子によって返される順序で FrameworkContext 内に格納されます。

定義:
インタフェース java.util.List 内の addAll
オーバーライド:
クラス java.util.Vector 内の addAll
パラメータ:
index - 指定されたコレクションから最初のプラグインを挿入する位置のインデックス
c - FrameworkContext に挿入されるプラグイン
戻り値:
この呼び出しの結果、この FrameworkContext が変更された場合は true
例外:
java.lang.IndexOutOfBoundsException - インデックスが範囲外の場合 (index < 0 || index > size())
java.lang.NullPointerException - 指定されたコレクションが null である場合
java.lang.IllegalArgumentException - 指定されたコレクションの要素がプラグインでない場合、または同じ名前のプラグインが FrameworkContext にあった場合
関連項目:
List.addAll(int, Collection)

addElement

public void addElement(java.lang.Object element)

指定のプラグインを FrameworkContext の最後に追加し、サイズを 1 増やします。 サイズが FrameworkContext の容量より大きくなるときは容量が増やされます。

このメソッドは機能的に add(Object) メソッドと同じです。これは、List インタフェースの一部です。

オーバーライド:
クラス java.util.Vector 内の addElement
パラメータ:
element - 追加されるプラグイン
例外:
java.lang.IllegalArgumentException - 指定されたオブジェクトがプラグインでない場合、または同じ名前のプラグインが FrameworkContext にあった場合
関連項目:
add(Object)

insertElementAt

public void insertElementAt(java.lang.Object element,
                            int index)

FrameworkContext の指定された index に、指定されたプラグインを挿入します。 指定された index に等しいか、それより大きいインデックスのプラグインはすべて 1 つ後方のインデックスにずれます。

インデックスは、0 に等しいか、それより大きい値でなければなりません。 また、FrameworkContext の現在のサイズに等しいか、それより小さい値でなければなりません。 インデックスが FrameworkContext の現在のサイズに等しい場合、新しいプラグインは FrameworkContext の末尾に追加されます。

このメソッドは機能的に add(Object, int) メソッドと同じです。 これは、List インタフェースの一部です。 配列の使い方により適した形にするために add メソッドがパラメータの順序を逆にすることに注意してください。

オーバーライド:
クラス java.util.Vector 内の insertElementAt
パラメータ:
element - 挿入されるプラグイン
index - 新しいプラグインを挿入する位置
例外:
java.lang.ArrayIndexOutOfBoundsException - - インデックスが範囲外の場合 (index < 0 || index >= size())
java.lang.IllegalArgumentException - 指定されたオブジェクトがプラグインでない場合、または同じ名前のプラグインが FrameworkContext にあった場合
関連項目:
Vector.insertElementAt(Object, int)

remove

public java.lang.Object remove(int index)

FrameworkContext 内の指定の位置にあるプラグインを削除します。 それ以降にプラグインがあればそれらを左に移動し、各プラグインのインデックスから 1 を減らします。 FrameworkContext から削除されたプラグインを返します。

定義:
インタフェース java.util.List 内の remove
オーバーライド:
クラス java.util.Vector 内の remove
パラメータ:
index - 削除されるプラグインのインデックス
例外:
java.lang.ArrayIndexOutOfBoundsException - - インデックスが範囲外の場合 (index < 0 || index >= size())
関連項目:
List.remove(int)

remove

public boolean remove(java.lang.Object element)

FrameworkContext 内で最初に検出された指定のプラグインを削除します。 FrameworkContext がプラグインを保持していない場合は、変更されません。 つまり、(element == null ? get(i) == null : element.equals(get(i))) であるもっとも小さいインデックス i を持つプラグインがあれば削除します。

定義:
インタフェース java.util.List 内の remove
オーバーライド:
クラス java.util.Vector 内の remove
パラメータ:
element - FrameworkContext から削除されるプラグイン (そのプラグインがある場合)
戻り値:
指定されたプラグインが FrameworkContext 内にあった場合は true
関連項目:
Collection.remove(Object)

removeAll

public boolean removeAll(java.util.Collection c)

FrameworkContext から、指定された Collection 内に保持されているすべてのプラグインを削除します。

定義:
インタフェース java.util.List 内の removeAll
オーバーライド:
クラス java.util.Vector 内の removeAll
パラメータ:
c - FrameworkContext から削除されるプラグインのコレクション
戻り値:
FrameworkContext が呼び出しの結果として変更された場合は true
例外:
java.lang.NullPointerException - 指定されたコレクションが null である場合
関連項目:
Collection.removeAll(Collection)

removeAllElements

public void removeAllElements()

FrameworkContext からすべてのプラグインを削除し、サイズを 0 に設定します。

このメソッドは機能的に clear メソッドと同じです。 これは、List インタフェースの一部です。

オーバーライド:
クラス java.util.Vector 内の removeAllElements
関連項目:
Vector.removeAllElements()

removeElement

public boolean removeElement(java.lang.Object element)

最初に検出された (最小インデックスの) 引数のプラグインを FrameworkContext から削除します。 プラグインが検出されると、そのプラグインのインデックスと同じかそれより大きいインデックスのプラグインはすべて 1 つ前方のインデックスに詰められます。

このメソッドは機能的に remove(Object) メソッドと同じです。 これは、List インタフェースの一部です。

オーバーライド:
クラス java.util.Vector 内の removeElement
パラメータ:
element - 削除されるプラグイン
戻り値:
引数が FrameworkContext のプラグインである場合は true、そうでない場合は false
関連項目:
Vector.removeElement(Object)

removeElementAt

public void removeElementAt(int index)

指定されたインデックスのプラグインを削除します。 指定された index に等しいか、それより大きいインデックスのプラグインは、すべて 1 つ前方のインデックスに詰められます。 FrameworkContext のサイズは 1 だけ減らされます。

インデックスは、0 に等しいか、それより大きい値でなければなりません。 また、FrameworkContext の現在のサイズより小さい値でなければなりません。

このメソッドは機能的に remove メソッドと同じです。 これは、List インタフェースの一部です。 remove メソッドが指定の位置に格納されていた古い値を返すことに注意してください。

オーバーライド:
クラス java.util.Vector 内の removeElementAt
パラメータ:
index - 削除されるプラグインのインデックス
例外:
java.lang.ArrayIndexOutOfBoundsException - - インデックスが範囲外の場合 (index < 0 || index >= size())
関連項目:
Vector.removeElementAt(int)

retainAll

public boolean retainAll(java.util.Collection c)

指定された Collection 内に保持されている、FrameworkContext 内のプラグインだけを保持します。 つまり、FrameworkContext から、指定された Collection 内に保持されていないすべてのプラグインを削除します。

定義:
インタフェース java.util.List 内の retainAll
オーバーライド:
クラス java.util.Vector 内の retainAll
パラメータ:
c - FrameworkContext に保持されているプラグインのコレクション (ほかのすべてのプラグインは削除)
戻り値:
FrameworkContext が呼び出しの結果として変更された場合は true
例外:
java.lang.NullPointerException - 指定されたコレクションが null である場合
関連項目:
Collection.retainAll(Collection)

set

public java.lang.Object set(int index,
                            java.lang.Object element)

FrameworkContext 内の指定された位置にあるプラグインを、指定のプラグインで置き換えます。

定義:
インタフェース java.util.List 内の set
オーバーライド:
クラス java.util.Vector 内の set
パラメータ:
index - 置換されるプラグインのインデックス
element - 指定された位置に格納されるプラグイン
戻り値:
指定された位置に以前あったプラグイン
例外:
java.lang.ArrayIndexOutOfBoundsException - インデックスが範囲外の場合 (index < 0 || index >= size())
java.lang.IllegalArgumentException - 指定されたオブジェクトがプラグインでない場合、または同じ名前のプラグインが FrameworkContext にあった場合
関連項目:
List.set(int, Object)

setElementAt

public void setElementAt(java.lang.Object element,
                         int index)

FrameworkContext の指定された index のプラグインに、指定されたプラグインを設定します。 そのインデックスにあったプラグインは破棄されます。

インデックスは、0 に等しいか、それより大きい値でなければなりません。 また、FrameworkContext の現在のサイズより小さい値でなければなりません。

このメソッドは機能的に set メソッドと同じです。 これは、List インタフェースの一部です。 配列の使い方により近づけるために、set メソッドがパラメータの順序を逆にすることに注意してください。 また、set メソッドが指定の位置に格納されていた古い値を返すことにも注意してください。

オーバーライド:
クラス java.util.Vector 内の setElementAt
パラメータ:
element - プラグインに設定されるオブジェクト
index - インデックス
例外:
java.lang.ArrayIndexOutOfBoundsException - インデックスが範囲外の場合 (index < 0 || index >= size())
java.lang.IllegalArgumentException - 指定されたオブジェクトがプラグインでない場合、または同じ名前のプラグインが FrameworkContext にあった場合
関連項目:
Vector.setElementAt(Object, int)

get

public java.lang.Object get(java.lang.String key)

指定されたキーのプラグインを返します。 FrameworkContext がこのキーのプラグインを保持していない場合は null を返します。

パラメータ:
key - プラグインのキー
戻り値:
指定されたキーのプラグイン。指定されたキーのプラグインがない場合は null

clear

public void clear()

すべてのプラグインを FrameworkContext から削除します。 この呼び出しが返ると、それが例外をスローしないかぎり、FrameworkContext は空になります。

定義:
インタフェース java.util.List 内の clear
オーバーライド:
クラス java.util.Vector 内の clear
関連項目:
Collection.clear()

isRunning

public boolean isRunning()

FrameworkContext がスタートしている場合に true を返します。

定義:
インタフェース LifeCycle 内の isRunning
戻り値:
FrameworkContext がスタートしている場合は true
関連項目:
LifeCycle.isRunning()

start

public void start()
           throws LifeCycleException

FrameworkContext をスタートします。

定義:
インタフェース LifeCycle 内の start
例外:
LifeCycleException - FrameworkContext のスタート処理中に問題が起こった場合
関連項目:
LifeCycle.start()

stop

public void stop()
          throws LifeCycleException

FrameworkContext をストップします。

定義:
インタフェース LifeCycle 内の stop
例外:
LifeCycleException - FrameworkContext のストップ処理中に問題が起こった場合
関連項目:
LifeCycle.stop()


>すべてのクラス'); } //--> 概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド