org.apache.abdera.model
Interface Base

All Superinterfaces:
Cloneable
All Known Subinterfaces:
Categories, Category, Collection, Content, Control, DateTime, Div, Document<T>, Element, Entry, ExtensibleElement, Feed, Generator, IRIElement, Link, Person, Service, Source, Text, Workspace
All Known Implementing Classes:
Bar, DateTimeWrapper, ElementWrapper, Error, ExtensibleElementWrapper, Foo, PersonWrapper

public interface Base
extends Cloneable

The Base interface provides the basis for the Feed Object Model API and defines the operations common to both the Element and Document interfaces. Classes implementing Base MUST NOT be assumed to be thread safe. Developers wishing to allow multiple threads to perform concurrent modifications to a Base MUST provide their own synchronization.


Method Summary
<T extends Base>
T
addComment(String value)
          Add an XML comment to this Base
 Object clone()
          Clone this Base
<T extends Base>
T
complete()
          Ensure that the underlying streams are fully parsed.
 WriterOptions getDefaultWriterOptions()
          Get the default WriterOptions for this object
 Factory getFactory()
          Get the Factory used to create this Base
 void writeTo(OutputStream out)
          Serializes the model component out to the specified stream
 void writeTo(OutputStream out, WriterOptions options)
          Serializes the model component out to the specified stream
 void writeTo(String writer, OutputStream out)
          Serializes the model component out to the specified stream using the given Abdera writer
 void writeTo(String writer, OutputStream out, WriterOptions options)
          Serializes the model component out to the specified stream using the given abdera writer
 void writeTo(String writer, Writer out)
          Serializes the model component out to the specified java.io.Writer using the given Abdera writer
 void writeTo(String writer, Writer out, WriterOptions options)
          Serializes the model component out to the specified java.io.Writer using the given abdera writer
 void writeTo(Writer writer)
          Serializes the model component out to the specified writer
 void writeTo(Writer writer, OutputStream out)
          Serializes the model component out to the specified stream using the given Abdera writer
 void writeTo(Writer writer, OutputStream out, WriterOptions options)
          Serializes the model component out to the specified stream using the given abdera writer
 void writeTo(Writer writer, Writer out)
          Serializes the model component out to the specified java.io.Writer using the given Abdera writer
 void writeTo(Writer out, WriterOptions options)
          Serializes the model component out to the specified java.io.Writer
 void writeTo(Writer writer, Writer out, WriterOptions options)
          Serializes the model component out to the specified java.io.Writer using the given abdera writer
 

Method Detail

getDefaultWriterOptions

WriterOptions getDefaultWriterOptions()
Get the default WriterOptions for this object


writeTo

void writeTo(OutputStream out,
             WriterOptions options)
             throws IOException
Serializes the model component out to the specified stream

Parameters:
out - The target output stream
options - The WriterOptions to use
Throws:
IOException

writeTo

void writeTo(Writer out,
             WriterOptions options)
             throws IOException
Serializes the model component out to the specified java.io.Writer

Parameters:
out - The target output writer
options - The WriterOptions to use
Throws:
IOException

writeTo

void writeTo(Writer writer,
             OutputStream out)
             throws IOException
Serializes the model component out to the specified stream using the given Abdera writer

Parameters:
writer - The Abdera writer to use
out - The target output stream
Throws:
IOException

writeTo

void writeTo(Writer writer,
             Writer out)
             throws IOException
Serializes the model component out to the specified java.io.Writer using the given Abdera writer

Parameters:
writer - The Abdera writer to use
out - The target output writer
Throws:
IOException

writeTo

void writeTo(String writer,
             OutputStream out)
             throws IOException
Serializes the model component out to the specified stream using the given Abdera writer

Parameters:
writer - The Abdera writer to use
out - The target output stream
Throws:
IOException

writeTo

void writeTo(String writer,
             Writer out)
             throws IOException
Serializes the model component out to the specified java.io.Writer using the given Abdera writer

Parameters:
writer - The Abdera writer to use
out - The target output writer
Throws:
IOException

writeTo

void writeTo(Writer writer,
             OutputStream out,
             WriterOptions options)
             throws IOException
Serializes the model component out to the specified stream using the given abdera writer

Parameters:
writer - The Abdera writer to use
out - The target output stream
options - The WriterOptions to use
Throws:
IOException

writeTo

void writeTo(Writer writer,
             Writer out,
             WriterOptions options)
             throws IOException
Serializes the model component out to the specified java.io.Writer using the given abdera writer

Parameters:
writer - The Abdera writer to use
out - The target output writer
options - The WriterOptions to use
Throws:
IOException

writeTo

void writeTo(String writer,
             OutputStream out,
             WriterOptions options)
             throws IOException
Serializes the model component out to the specified stream using the given abdera writer

Parameters:
writer - The name of the Abdera writer to use
out - The target output stream
options - The WriterOptions to use
Throws:
IOException

writeTo

void writeTo(String writer,
             Writer out,
             WriterOptions options)
             throws IOException
Serializes the model component out to the specified java.io.Writer using the given abdera writer

Parameters:
writer - The name of the Abdera writer to use
out - The target output writer
options - The WriterOptions to use
Throws:
IOException

writeTo

void writeTo(OutputStream out)
             throws IOException
Serializes the model component out to the specified stream

Parameters:
out - The java.io.OutputStream to use when serializing the Base. The charset encoding specified for the document will be used
Throws:
IOException

writeTo

void writeTo(Writer writer)
             throws IOException
Serializes the model component out to the specified writer

Parameters:
writer - The java.io.Writer to use when serializing the Base
Throws:
IOException

clone

Object clone()
Clone this Base


getFactory

Factory getFactory()
Get the Factory used to create this Base

Returns:
The Factory used to create this object

addComment

<T extends Base> T addComment(String value)
Add an XML comment to this Base

Parameters:
value - The text value of the comment

complete

<T extends Base> T complete()
Ensure that the underlying streams are fully parsed. Calling complete on an Element does not necessarily mean that the underlying stream is fully consumed, only that that particular element has been completely parsed.



Copyright © 2006-2010 Apache Software Foundation. All Rights Reserved.