abdera-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jmsn...@apache.org
Subject svn commit: r468560 - in /incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer: NamedWriter.java Writer.java WriterFactory.java
Date Fri, 27 Oct 2006 22:16:53 GMT
Author: jmsnell
Date: Fri Oct 27 15:16:52 2006
New Revision: 468560

URL: http://svn.apache.org/viewvc?view=rev&rev=468560
Log:
Javadoc improvements

Modified:
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/NamedWriter.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/Writer.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/WriterFactory.java

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/NamedWriter.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/NamedWriter.java?view=diff&rev=468560&r1=468559&r2=468560
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/NamedWriter.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/NamedWriter.java
Fri Oct 27 15:16:52 2006
@@ -17,12 +17,19 @@
 */
 package org.apache.abdera.writer;
 
+/**
+ * Named Writers provide a means of extending Abdera's built in serialization.
+ */
 public interface NamedWriter extends Writer {
 
+  /**
+   * Return the name used to acquire an instance of this Writer (case insensitive)
+   */
   String getName();
 
   /**
-   * Return the media type of the format produced by this writer
+   * Return a listing of MIME Media formats this NamedWriter is capable 
+   * of outputting.
    */
   String[] getOutputFormats();
   

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/Writer.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/Writer.java?view=diff&rev=468560&r1=468559&r2=468560
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/Writer.java (original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/Writer.java Fri
Oct 27 15:16:52 2006
@@ -22,16 +22,28 @@
 
 import org.apache.abdera.model.Base;
 
+/**
+ * Writers are used to serialize Abdera objects
+ */
 public interface Writer {
 
+  /**
+   * Serialized the given Abdera Base to the given outputstream 
+   */
   void writeTo(Base base, 
     OutputStream out) 
       throws IOException;
   
+  /**
+   * Serialized the given Abdera Base to the given writer  
+   */
   void writeTo(
     Base base, 
     java.io.Writer out) 
       throws IOException;
 
+  /**
+   * Return the serialized form of the Abdera Base
+   */
   Object write(Base base) throws IOException;
 }

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/WriterFactory.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/WriterFactory.java?view=diff&rev=468560&r1=468559&r2=468560
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/WriterFactory.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/WriterFactory.java
Fri Oct 27 15:16:52 2006
@@ -17,11 +17,31 @@
 */
 package org.apache.abdera.writer;
 
+/**
+ * The WriterFactory is used a acquire instances of alternative 
+ * writers registered with Abdera.  
+ * @see org.apache.abdera.writer.WriterParser 
+ */
 public interface WriterFactory {
   
+  /**
+   * Get the default writer. This is equivalent to calling 
+   * abdera.getWriter();
+   * @return The default writer
+   */
   Writer getWriter();
   
+  /**
+   * Get the named writer.
+   * @param name The name of the writer
+   * @returns The specified writer
+   */
   Writer getWriter(String name);
   
+  /**
+   * Return a writer capable of outputting the given MIME media type
+   * @param mediatype A MIME media type
+   * @return A matching writer
+   */
   Writer getWriterByMediaType(String mediatype);
 }



Mime
View raw message