[Cherbot-commit] SF.net SVN: cherbot: [52] trunk/src/net/sf/cherbot/Updatable.java

[<chr...@us...>]

Revision: 52
          http://svn.sourceforge.net/cherbot/?rev=52&view=rev
Author:   christianhujer
Date:     2007-06-09 10:15:40 -0700 (Sat, 09 Jun 2007)

Log Message:
-----------
Added updatable interface.

Added Paths:
-----------
    trunk/src/net/sf/cherbot/Updatable.java

Added: trunk/src/net/sf/cherbot/Updatable.java
===================================================================
--- trunk/src/net/sf/cherbot/Updatable.java	                        (rev 0)
+++ trunk/src/net/sf/cherbot/Updatable.java	2007-06-09 17:15:40 UTC (rev 52)
@@ -0,0 +1,22 @@
+/*
+ * Copyright © 2007, Christian Hujer and the CherBot developers. All Rights Reserved.
+ * License: GNU General Public License v2.0 or newer.
+ * See file COPYING in the root directory of this project.
+ */
+
+package net.sf.cherbot;
+
+/** Interface for classes that hold information which can be updated on demand.
+ * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ */
+public interface Updatable {
+
+    /** Update information.
+     * An update must be performed atomically.
+     * That means if this method returns normally, the implementing object must reflect the new state only.
+     * If this method throws an exception, the implementing object must remain unchanged and reflect its state prior to the failed update invocation.
+     * @throws Exception When the update couldn't be performed due to errors.
+     */
+    void update() throws Exception;
+
+} // interface Updatable


Property changes on: trunk/src/net/sf/cherbot/Updatable.java
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + LF


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.