JAL-1620 version bump and release notes
[jalview.git] / src / jalview / ws / io / mime / JalviewMimeContentHandler.java
index 9cbb4d7..8fef8da 100644 (file)
@@ -1,3 +1,23 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
+ * Copyright (C) 2014 The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview 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 General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.ws.io.mime;
 
 import jalview.io.packed.DataProvider;
@@ -14,12 +34,12 @@ import org.apache.james.mime4j.parser.ContentHandler;
 import org.apache.james.mime4j.parser.Field;
 
 /**
- * ContentHandler for parsing mime encoded messages into Jalview objects.
- * TODO: complete implementation
- * TODO: test implementation
- * TODO: hook in to Jalview IO and service response parser.
+ * ContentHandler for parsing mime encoded messages into Jalview objects. TODO:
+ * complete implementation TODO: test implementation TODO: hook in to Jalview IO
+ * and service response parser.
+ * 
  * @author JimP
- *
+ * 
  */
 public class JalviewMimeContentHandler implements ContentHandler
 {
@@ -30,117 +50,131 @@ public class JalviewMimeContentHandler implements ContentHandler
 
   /**
    * create a new handler to process a Jalview mime message.
+   * 
    * @param ds
    */
   public JalviewMimeContentHandler(JalviewDataset ds)
   {
-    context=ds;
+    context = ds;
   }
+
   /**
    * type of data pack being parsed currently
    */
   String currentType;
+
   /**
    * name of data pack being parsed currently
    */
   String currentName;
-  
+
   /**
-   * sources for data to be parsed 
+   * sources for data to be parsed
    */
-  List<DataProvider> dataItems = new ArrayList<DataProvider>(); 
-  
+  List<DataProvider> dataItems = new ArrayList<DataProvider>();
+
   @Override
   public void body(BodyDescriptor arg0, InputStream arg1)
           throws MimeException, IOException
   {
-    
+
     // TODO Auto-generated method stub
-    
+
   }
 
   @Override
   public void endBodyPart() throws MimeException
   {
     // TODO Auto-generated method stub
-    
+
   }
 
   @Override
   public void endHeader() throws MimeException
   {
     // TODO Auto-generated method stub
-    
+
   }
 
   @Override
   public void endMessage() throws MimeException
   {
     // TODO Auto-generated method stub
-    
+
   }
 
   @Override
   public void endMultipart() throws MimeException
   {
     // TODO Auto-generated method stub
-    
+
   }
 
   @Override
   public void epilogue(InputStream arg0) throws MimeException, IOException
   {
     // TODO Auto-generated method stub
-    
+
   }
 
   @Override
   public void field(Field arg0) throws MimeException
   {
     // TODO Auto-generated method stub
-    
+
   }
 
   @Override
   public void preamble(InputStream arg0) throws MimeException, IOException
   {
     // TODO Auto-generated method stub
-    
+
   }
 
   @Override
   public void raw(InputStream arg0) throws MimeException, IOException
   {
     // TODO Auto-generated method stub
-    
+
   }
 
   @Override
   public void startBodyPart() throws MimeException
   {
     // TODO Auto-generated method stub
-    
+
   }
 
   @Override
   public void startHeader() throws MimeException
   {
     // TODO Auto-generated method stub
-    
+
   }
 
   @Override
   public void startMessage() throws MimeException
   {
     // TODO Auto-generated method stub
-    
+
   }
 
   @Override
   public void startMultipart(BodyDescriptor arg0) throws MimeException
   {
     // TODO Auto-generated method stub
-    
+
+  }
+
+  /**
+   * 
+   * @return data providers to parse each data file extracted from the mime
+   *         stream.
+   */
+  public Iterable<DataProvider> getJalviewDataProviders()
+  {
+    // TODO Auto-generated method stub
+    return null;
   }
 
 }