Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.message.ui / src / org / simantics / message / ui / AbstractEntry.java

diff --git a/bundles/org.simantics.message.ui/src/org/simantics/message/ui/AbstractEntry.java b/bundles/org.simantics.message.ui/src/org/simantics/message/ui/AbstractEntry.java
new file mode 100644 (file)
index 0000000..3a94a0e
--- /dev/null
+++ b/bundles/org.simantics.message.ui/src/org/simantics/message/ui/AbstractEntry.java
@@ -0,0 +1,120 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.message.ui;
+
+import java.io.PrintWriter;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.eclipse.core.runtime.PlatformObject;
+import org.eclipse.jface.resource.ImageDescriptor;
+import org.eclipse.ui.model.IWorkbenchAdapter;
+
+/**
+ * Everything that appears in LogView is Abstract Entry. It provides composite pattern.
+ */
+public abstract class AbstractEntry extends PlatformObject implements IWorkbenchAdapter {
+
+       /**
+        * The collection of direct children of this entry
+        */
+       private List<Object> children = new ArrayList<Object>();
+       protected Object parent;
+
+       /**
+        * Adds the specified child entry to the listing of children.
+        * If the specified child is <code>null</code>, no work is done
+        * 
+        * @param child
+        */
+       public void addChild(AbstractEntry child) {
+               if (child != null) {
+                       children.add(0, child);
+                       child.setParent(this);
+               }
+       }
+
+       /**
+        * @see IWorkbenchAdapter#getChildren(Object)
+        */
+       public Object[] getChildren(Object parent) {
+               return children.toArray();
+       }
+
+       /**
+        * @return true if this entry has children, false otherwise
+        */
+       public boolean hasChildren() {
+               return children.size() > 0;
+       }
+
+       /**
+        * @return the size of the child array
+        * 
+        * TODO rename to getChildCount(), or something more meaningful
+        */
+       public int size() {
+               return children.size();
+       }
+
+       /**
+        * @see IWorkbenchAdapter#getImageDescriptor(Object)
+        */
+       public ImageDescriptor getImageDescriptor(Object object) {
+               return null;
+       }
+
+       /**
+        * @see IWorkbenchAdapter#getLabel(Object)
+        */
+       public String getLabel(Object o) {
+               return null;
+       }
+
+       /**
+        * @see IWorkbenchAdapter#getParent(Object)
+        */
+       public Object getParent(Object o) {
+               return parent;
+       }
+
+       /**
+        * Sets the parent of this entry
+        * @param parent
+        */
+       public void setParent(AbstractEntry parent) {
+               this.parent = parent;
+       }
+
+       /**
+        * removes all of the children specified in the given listing
+        * 
+        * @param list the list of children to remove
+        */
+       public void removeChildren(List<?> list) {
+               children.removeAll(list);
+       }
+
+       /**
+        * Removes all of the children from this entry
+        */
+       public void removeAllChildren() {
+               children.clear();
+       }
+
+       /**
+        * Writes this entry information into the given {@link PrintWriter}
+        * 
+        * @param writer
+        */
+       public abstract void write(PrintWriter writer);
+}