Rename xxx.lttng to xxx.lttng.core

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf / src / org / eclipse / linuxtools / tmf / filter / model / ITmfFilterTreeNode.java

/*******************************************************************************\r
 * Copyright (c) 2010 Ericsson\r
 * \r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 * \r
 * Contributors:\r
 *   Francois Godin (copelnug@gmail.com) - Initial API\r
 *   Yuriy Vashchuk (yvashchuk@gmail.com) - Initial implementation\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.filter.model;\r
\r
import java.util.List;\r
\r
import org.eclipse.linuxtools.tmf.filter.ITmfFilter;\r
\r
\r
/**\r
 * <h4>This is Node Interface in the Filter Tree</h4>\r
 */\r
public interface ITmfFilterTreeNode extends ITmfFilter {\r
	\r
	/**\r
	 * <h4>Get the parent node of current node</h4>\r
	 * \r
	 * @return The parent node (null when the node has no parent).\r
	 */\r
	public ITmfFilterTreeNode getParent();\r
	\r
	/**\r
	 * <h4>Get the current node name</h4>\r
	 * \r
	 * @return The name of the current node.\r
	 */\r
	public String getNodeName();\r
	\r
	/**\r
	 * <h4>Tell if the node has children</h4> \r
	 * \r
	 * @return True if the node has children.\r
	 */\r
	public boolean hasChildren();\r
	\r
	/**\r
	 * <h4>Return the number of children</h4>\r
	 * \r
	 * @return The number of children.\r
	 */\r
	public int getChildrenCount();\r
	\r
	/**\r
	 * <h4>Get the array of children</h4>\r
	 * \r
	 * @return The array (possibly empty) of children nodes.\r
	 */\r
	public ITmfFilterTreeNode[] getChildren();\r
	\r
	/**\r
	 * <h4>Get the node by index</h4>\r
	 * \r
	 * @param index The index of node to return.\r
	 * @return The desired node (null if the node is not exists).\r
	 */\r
	public ITmfFilterTreeNode getChild(int index);\r
	\r
	/**\r
	 * <h4>Remove the node from its parent</h4>\r
	 * \r
	 * <p>Shifts all nodes after the removed one to prevent having an empty spot. \r
	 * See {@link #replaceChildren(int, ITmfFilterTreeNode)} to replace a node.</p>\r
	 * \r
	 * @return The removed node. \r
	 */\r
	public ITmfFilterTreeNode remove();\r
	\r
	/**\r
	 * <h4>Remove the child from the current node</h4>\r
	 * \r
	 * <p>Shifts all nodes after the removed one to prevent having an empty spot. \r
	 * See {@link #replaceChildren(int, ITmfFilterTreeNode)} to replace a node.</p>\r
	 * \r
	 * @return The removed node. \r
	 */\r
	public ITmfFilterTreeNode removeChild(ITmfFilterTreeNode node);\r
	\r
	/**\r
	 * <h4>Append a node to the current children</h4>\r
	 * \r
	 * @param node Node to append.\r
	 * @return Index of added node (-1 if the node cannot be added).\r
	 */\r
	public int addChild(ITmfFilterTreeNode node);\r
	\r
	/**\r
	 * <h4>Replace a child node</h4>\r
	 * \r
	 * @param index Index of the node to replace.\r
	 * @param node Node who will replace.\r
	 * @return Node replaced.\r
	 */\r
	public ITmfFilterTreeNode replaceChild(int index, ITmfFilterTreeNode node);\r
\r
	/**\r
	 * <h4>Sets the parent of current node</h4>\r
	 * \r
	 * @param parent The parent of current node.\r
	 */\r
	public void setParent(ITmfFilterTreeNode parent);\r
	\r
	/**\r
	 * <h4>Gets the list of valid children node names that could be added to the node</h4>\r
	 * \r
	 * @return The list of valid children node names.\r
	 */\r
	public List<String> getValidChildren();\r
\r
	public ITmfFilterTreeNode clone();\r
	\r
}\r