annotate src/treecms/api/Forest.java @ 6:12604eb6b615

added javadoc
author shoshi
date Mon, 14 Mar 2011 23:24:38 +0900
parents 4a5ee88f02cf
children f96193babac0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7ecb9273581d hg init
shoshi
parents:
diff changeset
1 package treecms.api;
7ecb9273581d hg init
shoshi
parents:
diff changeset
2
6
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
3 /**
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
4 * ForestはNodeの集合で、集合に対するアクセスを提供します.クライアントはNodeIDを用いてNodeの取得や作成を行うことが出来ます.
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
5 * @author shoshi
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
6 */
1
bdde898e8ef9 add Forest
shoshi
parents: 0
diff changeset
7 public interface Forest
0
7ecb9273581d hg init
shoshi
parents:
diff changeset
8 {
6
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
9 /**
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
10 * NodeIDで示されるNodeを取得します.
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
11 * @param _id Nodeを示すNodeID.
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
12 * @return NodeIDと一致するNodeがある場合は,Nodeのインスタンスを返し,見つからない場合はnullを返します.
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
13 */
1
bdde898e8ef9 add Forest
shoshi
parents: 0
diff changeset
14 Node get(NodeID _id);
6
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
15
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
16 /**
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
17 * 同じUUIDを持つNode中で最新のNodeを取得します.
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
18 * @param _uuid NodeIDのUUID
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
19 * @return UUIDと一致するNodeが見つからない場合はnullを返します.
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
20 */
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
21 Node getTip(String _uuid);
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
22
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
23 /**
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
24 * 新しいNodeを作成します.このメソッドで作成されるNodeは新しいUUIDを持ちます.
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
25 * @return 新しいNode
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
26 */
2
4a5ee88f02cf added OnMemoryForest
shoshi
parents: 1
diff changeset
27 Node create();
6
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
28
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
29 /**
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
30 * NodeDataを保持する新しいNodeを作成します.このメソッドで作成されるNodeは新しいUUIDを持ちます.
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
31 * このメソッドはNodeDataをNodeに割り当てるとき防御的コピーを行います.
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
32 * @param _data 新しいNodeが保持するNodeData
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
33 * @return NodeDataを保持した新しいNode
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
34 */
12604eb6b615 added javadoc
shoshi
parents: 2
diff changeset
35 Node create(NodeData _data);
0
7ecb9273581d hg init
shoshi
parents:
diff changeset
36 }