Return-Path: Delivered-To: apmail-incubator-abdera-commits-archive@locus.apache.org Received: (qmail 71200 invoked from network); 27 Oct 2006 22:17:15 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 27 Oct 2006 22:17:15 -0000 Received: (qmail 79559 invoked by uid 500); 27 Oct 2006 22:17:27 -0000 Delivered-To: apmail-incubator-abdera-commits-archive@incubator.apache.org Received: (qmail 79550 invoked by uid 500); 27 Oct 2006 22:17:27 -0000 Mailing-List: contact abdera-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: abdera-dev@incubator.apache.org Delivered-To: mailing list abdera-commits@incubator.apache.org Received: (qmail 79537 invoked by uid 99); 27 Oct 2006 22:17:27 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 27 Oct 2006 15:17:27 -0700 X-ASF-Spam-Status: No, hits=0.6 required=10.0 tests=NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 27 Oct 2006 15:17:14 -0700 Received: by eris.apache.org (Postfix, from userid 65534) id 96CD01A984D; Fri, 27 Oct 2006 15:16:53 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit 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 -0000 To: abdera-commits@incubator.apache.org From: jmsnell@apache.org X-Mailer: svnmailer-1.1.0 Message-Id: <20061027221653.96CD01A984D@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org 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); }