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