javax.help

Class Merge

Known Direct Subclasses:
AppendMerge, NoMerge, SortMerge, UniteAppendMerge

public abstract class Merge
extends java.lang.Object

Common superclass for all merge types

Nested Class Summary

static class
Merge.DefaultMergeFactory
Default Merge factory which creates concrete Merge objects

Field Summary

protected Locale
locale
HelpSet's locale which is used in sorting
protected DefaultMutableTreeNode
slaveTopNode
Slave node

Constructor Summary

Merge(NavigatorView master, NavigatorView slave)
Constructs Merge for master and slave NavigatorViews

Method Summary

static void
mergeNodeChildren(TreeNode node)
Merge Node Children.
static void
mergeNodes(TreeNode master, TreeNode slave)
Merge Nodes.
abstract TreeNode
processMerge(TreeNode node)
Processes merge.

Field Details

locale

protected Locale locale
HelpSet's locale which is used in sorting

slaveTopNode

protected DefaultMutableTreeNode slaveTopNode
Slave node

Constructor Details

Merge

protected Merge(NavigatorView master,
                NavigatorView slave)
Constructs Merge for master and slave NavigatorViews
Parameters:
master - The master NavigatorView
slave - The slave NavigatorView

Method Details

mergeNodeChildren

public static void mergeNodeChildren(TreeNode node)
Merge Node Children. Merge the children of a node according to the merging rules of the parent. Each subclass must implement this method
Parameters:
node - The parent node from which the children are merged

mergeNodes

public static void mergeNodes(TreeNode master,
                              TreeNode slave)
Merge Nodes. Merge two nodes according to the merging rules of the masterNode. Each Subclass should override this implementation.
Parameters:
master - The master node to merge with
slave - The node to merge into the master

processMerge

public abstract TreeNode processMerge(TreeNode node)
Processes merge. Changes master node according merge rules using slave node.
Parameters:
node - The master node
Returns:
The changed master node