Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.message/src/org/simantics/message/ILogger.java b/bundles/org.simantics.message/src/org/simantics/message/ILogger.java
new file mode 100644 (file)
index 0000000..a17c70b
--- /dev/null
+++ b/bundles/org.simantics.message/src/org/simantics/message/ILogger.java
@@ -0,0 +1,59 @@
+/*******************************************************************************\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;\r
+\r
+import org.eclipse.core.runtime.IStatus;\r
+\r
+/**\r
+ * A log to which status events can be written. Logs appear on individual\r
+ * plug-ins and on the platform itself. Clients can register log listeners which\r
+ * will receive notification of all log events as they come in.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ * @noimplement This interface is not intended to be implemented by clients.\r
+ */\r
+public interface ILogger {\r
+\r
+    /**\r
+     * Adds the given log listener to this log.  Subsequently the log listener will\r
+     * receive notification of all log events passing through this log.\r
+     * This method has no affect if the identical listener is already registered on this log.\r
+     *\r
+     * @param listener the listener to add to this log\r
+     */\r
+    public void addLogListener(ILogListener listener);\r
+\r
+    /**\r
+     * Returns an identifier name for this log.\r
+     *\r
+     * @return the identifier name for this log\r
+     */\r
+    public String getName();\r
+\r
+    /**\r
+     * Logs the given status.  The status is distributed to the log listeners\r
+     * installed on this log and then to the log listeners installed on the platform.\r
+     *\r
+     * @param status the status to log\r
+     */\r
+    public void log(IStatus status);\r
+\r
+    /**\r
+     * Removes the given log listener to this log.  Subsequently the log listener will\r
+     * no longer receive notification of log events passing through this log.  \r
+     * This method has no affect if the identical listener is not registered on this log.\r
+     *\r
+     * @param listener the listener to remove\r
+     */\r
+    public void removeLogListener(ILogListener listener);\r
+\r
+}\r