org.apache.abdera.model
Interface Base

All Superinterfaces:
java.lang.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:
DateTimeWrapper, ElementWrapper, Error, ExtensibleElementWrapper, PersonWrapper

public interface Base
extends java.lang.Cloneable

The Base interface provides the basis for the Feed Object Model API and defines the operations common to both the Element and Document APIs. 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
 void addComment(java.lang.String value)
          Add an XML comment to this Base
 java.lang.Object clone()
          Clone this Base
 WriterOptions getDefaultWriterOptions()
           
 Factory getFactory()
          Get the Factory used to create this Base
 void writeTo(java.io.OutputStream out)
          Serializes the model component out to the specified stream
 void writeTo(java.io.OutputStream out, WriterOptions options)
          Serializes the model component out to the specified stream
 void writeTo(java.io.Writer writer)
          Serializes the model component out to the specified writer
 void writeTo(Writer writer, java.io.OutputStream out)
          Serializes the model component out to the specified stream using the given abdera writer
 void writeTo(Writer writer, java.io.OutputStream out, WriterOptions options)
          Serializes the model component out to the specified stream using the given abdera writer
 void writeTo(Writer writer, java.io.Writer out)
          Serializes the model component out to the specified java.io.Writer using the given abdera writer
 void writeTo(java.io.Writer out, WriterOptions options)
          Serializes the model component out to the specified java.io.Writer
 void writeTo(Writer writer, java.io.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()

writeTo

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

Throws:
java.io.IOException

writeTo

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

Throws:
java.io.IOException

writeTo

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

Throws:
java.io.IOException

writeTo

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

Throws:
java.io.IOException

writeTo

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

Throws:
java.io.IOException

writeTo

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

Throws:
java.io.IOException

writeTo

void writeTo(java.io.OutputStream out)
             throws java.io.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:
java.io.IOException

writeTo

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

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

clone

java.lang.Object clone()
Clone this Base


getFactory

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

Returns:
The Factory used to create this Base

addComment

void addComment(java.lang.String value)
Add an XML comment to this Base

Parameters:
value - The text value of the comment