[jsword-svn] r981 - trunk/jsword/src/main/java/org/crosswire/jsword/book/index

[dmsmith at crosswire.org]

Author: dmsmith
Date: 2006-01-23 11:56:36 -0700 (Mon, 23 Jan 2006)
New Revision: 981

Added:
   trunk/jsword/src/main/java/org/crosswire/jsword/book/index/IndexStatusEvent.java
   trunk/jsword/src/main/java/org/crosswire/jsword/book/index/IndexStatusListener.java
   trunk/jsword/src/main/java/org/crosswire/jsword/book/index/package.html
Log:
new home for index

Added: trunk/jsword/src/main/java/org/crosswire/jsword/book/index/IndexStatusEvent.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/book/index/IndexStatusEvent.java	2006-01-23 18:55:48 UTC (rev 980)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/book/index/IndexStatusEvent.java	2006-01-23 18:56:36 UTC (rev 981)
@@ -0,0 +1,66 @@
+/**
+ * Distribution License:
+ * JSword is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License, version 2.1 as published by
+ * the Free Software Foundation. This program is distributed in the hope
+ * that it will be useful, but WITHOUT ANY WARRANTY; without even the
+ * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Lesser General Public License for more details.
+ *
+ * The License is available on the internet at:
+ *       http://www.gnu.org/copyleft/lgpl.html
+ * or by writing to:
+ *      Free Software Foundation, Inc.
+ *      59 Temple Place - Suite 330
+ *      Boston, MA 02111-1307, USA
+ *
+ * Copyright: 2005
+ *     The copyright to this program is held by it's authors.
+ *
+ * ID: $Id: BooksEvent.java 763 2005-07-27 23:26:43Z dmsmith $
+ */
+package org.crosswire.jsword.book.index;
+
+import java.util.EventObject;
+
+
+/**
+ * An IndexStatusEvent is fired whenever the IndexStatus
+ * of a book has changed.
+ * 
+ * @see gnu.lgpl.License for license details.
+ *      The copyright to this program is held by it's authors.
+ * @author DM Smith [dmsmith555 at yahoo dot com]
+ */
+public class IndexStatusEvent extends EventObject
+{
+    /**
+     * Basic constructor
+     * @param status The new status of the book.
+     */
+    public IndexStatusEvent(Object source, IndexStatus status)
+    {
+        super(source);
+
+        indexStatus = status;
+    }
+
+    /**
+     * @return Returns the indexStatus.
+     */
+    public IndexStatus getIndexStatus()
+    {
+        return indexStatus;
+    }
+
+    /**
+     * The indexStatus of the book.
+     */
+    private transient IndexStatus indexStatus;
+
+    /**
+     * Serialization ID
+     */
+    private static final long serialVersionUID = 3834876879554819894L;
+
+}


Property changes on: trunk/jsword/src/main/java/org/crosswire/jsword/book/index/IndexStatusEvent.java
___________________________________________________________________
Name: astChangedRevision
   + 

Added: trunk/jsword/src/main/java/org/crosswire/jsword/book/index/IndexStatusListener.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/book/index/IndexStatusListener.java	2006-01-23 18:55:48 UTC (rev 980)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/book/index/IndexStatusListener.java	2006-01-23 18:56:36 UTC (rev 981)
@@ -0,0 +1,42 @@
+/**
+ * Distribution License:
+ * JSword is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License, version 2.1 as published by
+ * the Free Software Foundation. This program is distributed in the hope
+ * that it will be useful, but WITHOUT ANY WARRANTY; without even the
+ * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Lesser General Public License for more details.
+ *
+ * The License is available on the internet at:
+ *       http://www.gnu.org/copyleft/lgpl.html
+ * or by writing to:
+ *      Free Software Foundation, Inc.
+ *      59 Temple Place - Suite 330
+ *      Boston, MA 02111-1307, USA
+ *
+ * Copyright: 2005
+ *     The copyright to this program is held by it's authors.
+ *
+ * ID: $Id: BooksListener.java 763 2005-07-27 23:26:43Z dmsmith $
+ */
+package org.crosswire.jsword.book.index;
+
+import java.util.EventListener;
+
+
+/**
+ * IndexStatusListeners are able to be notified about changes to the
+ * IndexStatus of a book.
+ * 
+ * @see gnu.lgpl.License for license details.
+ *      The copyright to this program is held by it's authors.
+ * @author DM Smith [dmsmith555 at yahoo dot com]
+ */
+public interface IndexStatusListener extends EventListener
+{
+    /**
+     * Called whenever the IndexStatus of a book has changed.
+     * @param ev A description of the change
+     */
+    void statusChanged(IndexStatusEvent ev);
+}


Property changes on: trunk/jsword/src/main/java/org/crosswire/jsword/book/index/IndexStatusListener.java
___________________________________________________________________
Name: astChangedRevision
   + 

Added: trunk/jsword/src/main/java/org/crosswire/jsword/book/index/package.html
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/book/index/package.html	2006-01-23 18:55:48 UTC (rev 980)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/book/index/package.html	2006-01-23 18:56:36 UTC (rev 981)
@@ -0,0 +1,9 @@
+<html>
+<body>
+
+<p>
+  Abstraction of an Index.
+</p>
+
+</body>
+</html>


Property changes on: trunk/jsword/src/main/java/org/crosswire/jsword/book/index/package.html
___________________________________________________________________
Name: svn:executable
   + *