public class DefaultMutableTreeNode extends Object implements Cloneable, MutableTreeNode, Serializable
DefaultMutableTreeNode
は、ツリーデータ構造の汎用ノードです。デフォルトの可変ツリーノードの使用例は、「The Java Tutorial」の「How to Use Trees」を参照してください。
ツリーノードは最大 1 つの親と、ゼロ個以上の子を持ちます。DefaultMutableTreeNode
は、ノードの親と子の検査と変更を行うための操作と、そのノードによって構成されるツリーを検査する操作を提供します。ノードのツリーは、そのノードを起点とする親と子へのすべての可能なリンクをたどって到達できる、すべてのノードから構成されます。親を持たないノードはそのツリーのルートで、子を持たないノードは葉です。ツリーは多数のサブツリーを持つことができ、各ノードはそのサブツリーのルートになります。
このクラスは、ツリーまたはサブツリーをさまざまな順序で効率的にたどる方法や、2 つのノード間のパスをたどるための方法を列挙します。DefaultMutableTreeNode
には、ユーザーオブジェクトへの参照、つまりユーザーが独自に定義するオブジェクトへの参照も格納できます。DefaultMutableTreeNode
に toString()
を指定してその文字列表現を要求すると、そのユーザーオブジェクトの文字列表現を返します。
このクラスはスレッドセーフではありません。複数のスレッドで DefaultMutableTreeNode (つまり、TreeNode のツリー) を使用する場合、ユーザー自身が同期を行う必要があります。慣例では、ツリーのルートノードで同期させます。
DefaultMutableTreeNode は MutableTreeNode インタフェースを実装し、MutableTreeNode のあらゆる実装にメソッドを追加できますが、DefaultMutableTreeNode のすべてのメソッドが MutableTreeNode のすべての実装に適用できるとは限りません。提供される列挙の一部では特に、そうしたメソッドの一部を使用すると、DefaultMutableTreeNode は DefaultMutableNode のインスタンスだけを含む場合があります。TreeNode/MutableTreeNode メソッドはすべて、どの実装が追加されても定義されたように動作します。
警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースとの互換性がなくなる予定です。現在の直列化のサポートは、短期間の格納や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。1.4 以降、すべての JavaBeansTM 用の長期間の格納サポートが java.beans
パッケージに追加されています。XMLEncoder
を参照してください。
MutableTreeNode
修飾子と型 | フィールドと説明 |
---|---|
protected boolean |
allowsChildren
ノードが子を持つことができる場合は true です。
|
protected Vector |
children
複数の子の配列です。このノードに子がない場合は null です。
|
static Enumeration<TreeNode> |
EMPTY_ENUMERATION
常に空の列挙です。
|
protected MutableTreeNode |
parent
このノードの親です。このノードに親がない場合は null です。
|
protected Object |
userObject
オプションのユーザーオブジェクトです。
|
コンストラクタと説明 |
---|
DefaultMutableTreeNode()
親も子も持たないツリーノードを作成します。このツリーノードは子を持つことができます。
|
DefaultMutableTreeNode(Object userObject)
親も子も持たないツリーノードを作成し、指定されたユーザーオブジェクトで初期化します。このツリーノードは子を持つことができます。
|
DefaultMutableTreeNode(Object userObject, boolean allowsChildren)
親も子もないツリーノードを作成します。これは、指定されたユーザーオブジェクトで初期化され、指定された場合にかぎり子を持つことができます。
|
修飾子と型 | メソッドと説明 |
---|---|
void |
add(MutableTreeNode newChild)
newChild をその親から削除し、このノードの子配列の末尾に追加して、このノードの子にします。 |
Enumeration |
breadthFirstEnumeration()
このノードをルートにするサブツリーを幅優先でトラバースする列挙を生成して返します。
|
Enumeration |
children()
このノードの子の順方向列挙を作成して返します。
|
Object |
clone()
オーバーライドされて、複製を public にします。
|
Enumeration |
depthFirstEnumeration()
このノードをルートにするサブツリーを、深さ優先でトラバースする列挙を生成して返します。
|
boolean |
getAllowsChildren()
このノードが子を持つことを許可されている場合に true を返します。
|
TreeNode |
getChildAfter(TreeNode aChild)
このノードの子配列内で
aChild の直後にくる子を返します。なお、aChild はこのノードの子である必要があります。 |
TreeNode |
getChildAt(int index)
このノードの子配列にある、指定されたインデックスの子を返します。
|
TreeNode |
getChildBefore(TreeNode aChild)
このノードの子配列内で
aChild の直前にくる子を返します。なお、aChild はこのノードの子である必要があります。 |
int |
getChildCount()
このノードの子の数を返します。
|
int |
getDepth()
このノードをルートにするツリーの深さ、つまりこのノードから葉までの最長の距離を返します。
|
TreeNode |
getFirstChild()
このノードの最初の子を返します。
|
DefaultMutableTreeNode |
getFirstLeaf()
このノードの下位ノードである最初の葉、つまり、このノード、またはその最初の子の最初の葉のどちらかを見つけて返します。
|
int |
getIndex(TreeNode aChild)
このノードの子配列にある、指定された子のインデックスを返します。
|
TreeNode |
getLastChild()
このノードの最後の子を返します。
|
DefaultMutableTreeNode |
getLastLeaf()
このノードの下位ノードである最後の葉、つまり、このノード、またはその最後の子の最後の葉のどちらかを見つけて返します。
|
int |
getLeafCount()
このノードの下位ノードである葉の合計数を返します。
|
int |
getLevel()
このノードより上の部分のレベル数、つまりルートからこのノードまでの距離を返します。
|
DefaultMutableTreeNode |
getNextLeaf()
このノードの後ろの葉を返します。このノードがツリー内の最後の葉である場合は null を返します。
|
DefaultMutableTreeNode |
getNextNode()
このノードのツリーの前順走査でこのノードの次にあるノードを返します。
|
DefaultMutableTreeNode |
getNextSibling()
親の子配列にあるこのノードの次の兄弟を返します。
|
TreeNode |
getParent()
このノードの親を返します。このノードに親がない場合は null を返します。
|
TreeNode[] |
getPath()
ルートからこのノードに至るまでのパスを返します。
|
protected TreeNode[] |
getPathToRoot(TreeNode aNode, int depth)
ルートノードまでを含むノードの親を構築します。ただし、元のノードは返される配列内の最後の要素です。
|
DefaultMutableTreeNode |
getPreviousLeaf()
このノードの前の葉を返します。このノードがツリー内の最初の葉である場合は null を返します。
|
DefaultMutableTreeNode |
getPreviousNode()
このノードのツリーの前順走査でこのノードの前にあるノードを返します。
|
DefaultMutableTreeNode |
getPreviousSibling()
親の子配列にあるこのノードの直前の兄弟を返します。
|
TreeNode |
getRoot()
このノードを格納するツリーのルートを返します。
|
TreeNode |
getSharedAncestor(DefaultMutableTreeNode aNode)
このノードと
aNode にもっとも近い共通の上位ノードを返します。 |
int |
getSiblingCount()
このノードの兄弟数を返します。
|
Object |
getUserObject()
このノードのユーザーオブジェクトを返します。
|
Object[] |
getUserObjectPath()
ルートからこのノードに至るユーザーオブジェクトパスを返します。
|
void |
insert(MutableTreeNode newChild, int childIndex)
newChild をその親があればその親から削除し、子の親をこのノードに設定してから、子をこのノードの子配列のインデックス childIndex に追加します。 |
boolean |
isLeaf()
このノードに子がない場合は true を返します。
|
boolean |
isNodeAncestor(TreeNode anotherNode)
anotherNode がこのノードの上位ノードである場合、つまり、このノード、このノードの親、またはこのノードの親の上位ノードである場合に true を返します。 |
boolean |
isNodeChild(TreeNode aNode)
aNode がこのノードの子である場合は true を返します。 |
boolean |
isNodeDescendant(DefaultMutableTreeNode anotherNode)
anotherNode がこのノードの下位ノードである場合、つまり、このノード、このノードの複数の子の中の 1 つ、またはその複数の子の中の 1 つの下位ノードである場合に true を返します。 |
boolean |
isNodeRelated(DefaultMutableTreeNode aNode)
aNode がこのノードと同じツリーにある場合に true を返します。 |
boolean |
isNodeSibling(TreeNode anotherNode)
anotherNode がこのノードと同じ親を持つ兄弟である場合は true を返します。 |
boolean |
isRoot()
このノードがツリーのルートの場合は true を返します。
|
Enumeration |
pathFromAncestorEnumeration(TreeNode ancestor)
ancestor からこのノードまでのパスをたどる列挙を生成して返します。 |
Enumeration |
postorderEnumeration()
このノードをルートにするサブツリーを後順でトラバースする列挙を生成して返します。
|
Enumeration |
preorderEnumeration()
このノードをルートにするサブツリーを前順でトラバースする列挙を生成して返します。
|
void |
remove(int childIndex)
このノードの複数の子から、指定されたインデックスの子を削除し、そのノードの親を null に設定します。
|
void |
remove(MutableTreeNode aChild)
aChild をこのノードの子配列から削除し、それに null の親を与えます。 |
void |
removeAllChildren()
このノードの子をすべて削除し、それらの親を null に設定します。
|
void |
removeFromParent()
このノードをルートにするサブツリーをツリーから削除し、このノードに null の親を与えます。
|
void |
setAllowsChildren(boolean allows)
このノードが子を持つことを許可されるかどうかを設定します。
|
void |
setParent(MutableTreeNode newParent)
このノードの親を
newParent に設定しますが、親の子配列は変更しません。 |
void |
setUserObject(Object userObject)
このノードのユーザーオブジェクトを
userObject に設定します。 |
String |
toString()
toString() をこのノードのユーザーオブジェクトに送った結果を返します。このノードにユーザーオブジェクトがない場合は空の文字列を返します。 |
public static final Enumeration<TreeNode> EMPTY_ENUMERATION
protected MutableTreeNode parent
protected Vector children
protected transient Object userObject
protected boolean allowsChildren
public DefaultMutableTreeNode()
public DefaultMutableTreeNode(Object userObject)
userObject
- ユーザーが提供する、ノードのデータを構成する Objectpublic DefaultMutableTreeNode(Object userObject, boolean allowsChildren)
userObject
- ユーザーが提供する、ノードのデータを構成する ObjectallowsChildren
- true の場合、ノードは子ノードを持つことを許可される。そうでない場合、常に葉ノードpublic void insert(MutableTreeNode newChild, int childIndex)
newChild
をその親があればその親から削除し、子の親をこのノードに設定してから、子をこのノードの子配列のインデックス childIndex
に追加します。newChild
は null、およびこのノードの上位ノードにすることはできません。insert
、インタフェース: MutableTreeNode
newChild
- このノードより下位の部分に挿入する MutableTreeNodechildIndex
- このノードの挿入先である、このノードの子配列のインデックスArrayIndexOutOfBoundsException
- childIndex
が範囲外にある場合IllegalArgumentException
- newChild
が null の場合、またはこのノードの上位ノードである場合IllegalStateException
- このノードが子を許可しない場合isNodeDescendant(javax.swing.tree.DefaultMutableTreeNode)
public void remove(int childIndex)
MutableTreeNode
でなければいけません。remove
、インタフェース: MutableTreeNode
childIndex
- このノードの子配列で削除する対象の子のインデックスArrayIndexOutOfBoundsException
- childIndex
が範囲外にある場合public void setParent(MutableTreeNode newParent)
newParent
に設定しますが、親の子配列は変更しません。このメソッドは子の親を再び割り当てるために、insert()
と remove()
から呼び出されます。ほかのメソッドからメッセージとして送られることはありません。setParent
、インタフェース: MutableTreeNode
newParent
- このノードの新しい親public TreeNode getParent()
public TreeNode getChildAt(int index)
getChildAt
、インタフェース: TreeNode
index
- このノードの子配列のインデックスArrayIndexOutOfBoundsException
- index
が範囲外にある場合public int getChildCount()
getChildCount
、インタフェース: TreeNode
public int getIndex(TreeNode aChild)
-1
を返します。このメソッドは O(n) の線形探索を実行します。n は子の数です。getIndex
、インタフェース: TreeNode
aChild
- このノードの複数の子の中から検索する TreeNode-1
IllegalArgumentException
- aChild
が null である場合public Enumeration children()
public void setAllowsChildren(boolean allows)
allows
が false の場合は、このノードの子はすべて削除されます。
注:デフォルトでは、ノードは子を許可します。
allows
- このノードが子を持つことを許可される場合は truepublic boolean getAllowsChildren()
getAllowsChildren
、インタフェース: TreeNode
public void setUserObject(Object userObject)
userObject
に設定します。setUserObject
、インタフェース: MutableTreeNode
userObject
- このノードのユーザー指定のデータを構成する ObjectgetUserObject()
, toString()
public Object getUserObject()
setUserObject(java.lang.Object)
, toString()
public void removeFromParent()
removeFromParent
、インタフェース: MutableTreeNode
public void remove(MutableTreeNode aChild)
aChild
をこのノードの子配列から削除し、それに null の親を与えます。remove
、インタフェース: MutableTreeNode
aChild
- 削除するこのノードの子IllegalArgumentException
- aChild
が null の場合、またはこのノードの子でない場合public void removeAllChildren()
public void add(MutableTreeNode newChild)
newChild
をその親から削除し、このノードの子配列の末尾に追加して、このノードの子にします。newChild
- このノードの子として追加するノードIllegalArgumentException
- newChild
が null である場合IllegalStateException
- このノードが子を許可しない場合insert(javax.swing.tree.MutableTreeNode, int)
public boolean isNodeAncestor(TreeNode anotherNode)
anotherNode
がこのノードの上位ノードである場合、つまり、このノード、このノードの親、またはこのノードの親の上位ノードである場合に true を返します。(ノードはそれ自身の上位ノードと見なされることに注意してください。) anotherNode
が null の場合、このメソッドは false を返します。この操作は最低でも O(h) です。h はルートからこのノードまでの距離です。anotherNode
- このノードの上位ノードであるかどうかを調べるノードanotherNode
の下位ノードである場合は trueisNodeDescendant(javax.swing.tree.DefaultMutableTreeNode)
, getSharedAncestor(javax.swing.tree.DefaultMutableTreeNode)
public boolean isNodeDescendant(DefaultMutableTreeNode anotherNode)
anotherNode
がこのノードの下位ノードである場合、つまり、このノード、このノードの複数の子の中の 1 つ、またはその複数の子の中の 1 つの下位ノードである場合に true を返します。ノードはそれ自身の下位ノードと見なされます。anotherNode
が null の場合、false を返します。この操作は最低でも O(h) です。h はルートから anotherNode
までの距離です。anotherNode
- このノードの下位ノードであるかどうかを調べるノードanotherNode
の上位ノードである場合は trueisNodeAncestor(javax.swing.tree.TreeNode)
, getSharedAncestor(javax.swing.tree.DefaultMutableTreeNode)
public TreeNode getSharedAncestor(DefaultMutableTreeNode aNode)
aNode
にもっとも近い共通の上位ノードを返します。そのような上位ノードがない場合、つまりこのノードと aNode
が異なるツリーにある場合や、aNode
が null の場合は、null を返します。ノードはそれ自身の上位ノードと見なされます。aNode
- 共通の上位ノードを見つけるノードaNode
にもっとも近い共通の上位ノード。ない場合は nullisNodeAncestor(javax.swing.tree.TreeNode)
, isNodeDescendant(javax.swing.tree.DefaultMutableTreeNode)
public boolean isNodeRelated(DefaultMutableTreeNode aNode)
aNode
がこのノードと同じツリーにある場合に true を返します。aNode
が null の場合、false を返します。aNode
がこのノードと同じツリーにある場合は true、aNode
が null の場合は falsegetSharedAncestor(javax.swing.tree.DefaultMutableTreeNode)
, getRoot()
public int getDepth()
getLevel()
よりもかなり負荷が大きくなります。getLevel()
public int getLevel()
getDepth()
public TreeNode[] getPath()
protected TreeNode[] getPathToRoot(TreeNode aNode, int depth)
aNode
- パスを取得する TreeNodedepth
- 返される配列のサイズ指定に使用する、(再帰呼び出しで) すでに取得済みのルートまでのステップ数を示す int 値public Object[] getUserObjectPath()
public TreeNode getRoot()
isNodeAncestor(javax.swing.tree.TreeNode)
public boolean isRoot()
public DefaultMutableTreeNode getNextNode()
preorderEnumeration()
public DefaultMutableTreeNode getPreviousNode()
null
を返します。これはツリー全体をトラバースする方法としては効率的ではないので、代わりに列挙を使用します。preorderEnumeration()
public Enumeration preorderEnumeration()
nextElement()
メソッドによって返される最初のノードは、このノードです。ノードの挿入、削除、移動でツリーを変更すると、変更前に作成された任意の列挙は無効になります。
postorderEnumeration()
public Enumeration postorderEnumeration()
nextElement()
メソッドによって返される最初のノードは、左端の葉です。これは、深さ優先走査と同じです。ノードの挿入、削除、移動でツリーを変更すると、変更前に作成された任意の列挙は無効になります。
depthFirstEnumeration()
, preorderEnumeration()
public Enumeration breadthFirstEnumeration()
nextElement()
メソッドによって返される最初のノードは、このノードです。ノードの挿入、削除、移動でツリーを変更すると、変更前に作成された任意の列挙は無効になります。
depthFirstEnumeration()
public Enumeration depthFirstEnumeration()
nextElement()
メソッドによって返される最初のノードは、左端の葉です。これは、ポストオーダ探索と同じです。ノードの挿入、削除、移動でツリーを変更すると、変更前に作成された任意の列挙は無効になります。
breadthFirstEnumeration()
, postorderEnumeration()
public Enumeration pathFromAncestorEnumeration(TreeNode ancestor)
ancestor
からこのノードまでのパスをたどる列挙を生成して返します。列挙の nextElement()
メソッドは、最初に ancestor
、次にこのノードの上位ノードである ancestor
の子というように順次返していき、最後にこのノードを返します。列挙の生成は O(m) です。m はこのノードと ancestor
の間 (このノードと ancestor を含む) のノード数です。各 nextElement()
メッセージは O(1) です。ノードの挿入、削除、移動でツリーを変更すると、変更前に作成された任意の列挙は無効になります。
IllegalArgumentException
- ancestor
がこのノードの上位ノードでない場合isNodeAncestor(javax.swing.tree.TreeNode)
, isNodeDescendant(javax.swing.tree.DefaultMutableTreeNode)
public boolean isNodeChild(TreeNode aNode)
aNode
がこのノードの子である場合は true を返します。aNode
が null の場合、このメソッドは false を返します。aNode
がこのノードの子である場合は true。aNode
が null の場合は falsepublic TreeNode getFirstChild()
NoSuchElementException
- このノードに子がない場合public TreeNode getLastChild()
NoSuchElementException
- このノードに子がない場合public TreeNode getChildAfter(TreeNode aChild)
aChild
の直後にくる子を返します。なお、aChild はこのノードの子である必要があります。aChild
が最後の子の場合は、null を返します。このメソッドは、このノードの子の O(n) の線形探索を実行して aChild
を探します。n は子の数です。子の配列全体をトラバースするには、代わりに列挙を使用します。aChild
の直後にくるこのノードの子IllegalArgumentException
- aChild
が null の場合、またはこのノードの子でない場合children
public TreeNode getChildBefore(TreeNode aChild)
aChild
の直前にくる子を返します。なお、aChild はこのノードの子である必要があります。aChild
が最初の子の場合、null を返します。このメソッドは、このノードの子の O(n) の線形探索を実行して aChild
を探します。n は子の数です。aChild
の直前にくるこのノードの子IllegalArgumentException
- aChild
が null の場合、またはこのノードの子でない場合public boolean isNodeSibling(TreeNode anotherNode)
anotherNode
がこのノードと同じ親を持つ兄弟である場合は true を返します。ノードはそれ自身の兄弟です。anotherNode
が null の場合、false を返します。anotherNode
- このノードの兄弟であるかどうかを調べるノードanotherNode
がこのノードの兄弟の場合は truepublic int getSiblingCount()
1
を返します。public DefaultMutableTreeNode getNextSibling()
children
public DefaultMutableTreeNode getPreviousSibling()
public boolean isLeaf()
getAllowsChildren
と組み合わせて使用します。isLeaf
、インタフェース: TreeNode
getAllowsChildren()
public DefaultMutableTreeNode getFirstLeaf()
isLeaf()
, isNodeDescendant(javax.swing.tree.DefaultMutableTreeNode)
public DefaultMutableTreeNode getLastLeaf()
isLeaf()
, isNodeDescendant(javax.swing.tree.DefaultMutableTreeNode)
public DefaultMutableTreeNode getNextLeaf()
MutableNode
インタフェースのこの実装では、この操作はあまり効率的ではありません。次のノードを判定するには、このメソッドは最初に現在のノードを見つけるために親の子リストで線形探索を実行します。
この実装は、操作を既知の位置から短いトラバーサルを行うのに適したものにします。ツリー内のすべての葉をトラバースするには、depthFirstEnumeration
を使用してツリー内のノードを列挙し、isLeaf
を各ノードに使用してどれが葉であるかを判定します。
depthFirstEnumeration()
, isLeaf()
public DefaultMutableTreeNode getPreviousLeaf()
MutableNode
インタフェースのこの実装では、この操作はあまり効率的ではありません。直前のノードを判定するには、このメソッドは最初に現在のノードを見つけるために親の子リストで線形探索を実行します。
この実装は、操作を既知の位置から短いトラバーサルを行うのに適したものにします。ツリー内のすべての葉をトラバースするには、depthFirstEnumeration
を使用してツリー内のノードを列挙し、isLeaf
を各ノードに使用してどれが葉であるかを判定します。
depthFirstEnumeration()
, isLeaf()
public int getLeafCount()
1
を返します。このメソッドは O(n) です。n はこのノードの下位ノードの数です。isNodeAncestor(javax.swing.tree.TreeNode)
public String toString()
toString()
をこのノードのユーザーオブジェクトに送った結果を返します。このノードにユーザーオブジェクトがない場合は空の文字列を返します。toString
、クラス: Object
getUserObject()
バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.