Mercurial > hg > Members > shoshi > TreeCMSv2

comparison src/treecms/api/TreeEditor.java @ 6:12604eb6b615

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added javadoc
author shoshi
date Mon, 14 Mar 2011 23:24:38 +0900
parents 7ecb9273581d
children fc19e38b669b
comparison
equal deleted inserted replaced
5:87bba22e4fa2 6:12604eb6b615
1 package treecms.api; 1 package treecms.api;
2 2
3 /**
4 * 木構造を非破壊的に更新する機能を提供します．TreeEditorはTreeを非破壊的に更新していき，commitすることでTreeに更新を適用します．
5 * TreeEditor.getRootはcommitされていない状態のRootNodeを取得します．
6 * この機能は分散リポジトリを参考に考案されました．
7 * @author shoshi
8 */
3 public interface TreeEditor extends Tree 9 public interface TreeEditor extends Tree
4 { 10 {
5 //commit local tree to remote tree 11 /**
12 * 非破壊的に更新した木構造を適用します．
13 * 更新する際に他の方法により木構造がすでに更新されていた場合，commitは失敗します。_forceがtrueの場合，強制的に置き換えます．
14 * @param _force 強制コミットフラグ
15 * @return 成功した場合true，失敗した場合false
16 */
6 public boolean commit(boolean _force); 17 public boolean commit(boolean _force);
7 18
8 //pull updates from remote tree 19 /**
20 * 監視している木構造をEditorにキャッシュします．
21 * @return キャッシュが成功した場合はtrue，失敗した場合はfalse
22 */
9 public boolean pull(); 23 public boolean pull();
10 24
11 //check that is remote tree modified. 25 /**
26 * 監視されている木構造が更新されていないかチェックします．
27 * @return 更新されていた場合はture，されていない場合はfalse
28 */
12 public boolean check(); 29 public boolean check();
13 30
14 //merge remote tree to local tree 31 /**
32 * 監視している木構造をキャッシュにマージします．
33 */
15 public void merge(); 34 public void merge();
35
36 /**
37 * 木構造を非破壊的に更新します．
38 * @param _target 更新する対象のNode
39 * @param _newData 新しいNodeに割り当てられるNodeData
40 * @return 更新された新しいNode
41 */
42 public Node updateTree(Node _target,NodeData _newData);
16 } 43 }