Atom::Core::AtomEntry

AtomEntry Class Reference

The Atom entry.

See also:: AtomFeed

Inheritance diagram for AtomEntry:


Public Member Functions
	AtomEntry (Uri ns)
	Initialize a new instance of the AtomEntry class.
override string	ToString ()
	Converts the AtomEntry in a series of xml nodes.
void	Save (Stream stream)
	Saves the AtomEntry to the specified Stream.
void	Save (string filename)
	Saves the AtomEntry to the specified filename.
void	Save (TextWriter tw)
	Saves the AtomEntry to the specified TextWriter.
void	Save (XmlWriter xw)
	Saves the AtomEntry to the specified TextWriter.
void	Save (WebResponse response)
	Saves the AtomEntry to the specified WebResponse.
Static Public Member Functions
static AtomEntry	Load (string uri, Uri ns)
	Loads the AtomEntry from the specified URI.
static AtomEntry	Load (Uri uri, Uri ns)
	Loads the AtomEntry from the specified System.Uri.
static AtomEntry	Load (Stream stream, Uri ns)
	Loads the AtomEntry from the specified Stream.
static AtomEntry	Load (TextReader tr, Uri ns)
	Loads the AtomEntry from the specified TextReader.
static AtomEntry	Load (WebRequest request, Uri ns)
	Loads the AtomEntry from the specified WebRequest.
static AtomEntry	Load (XmlReader reader, Uri ns)
	Loads the AtomEntry from the specified XmlReader.
static AtomEntry	LoadXml (string xmlFragment, Uri ns)
	Loads the AtomEntry from the specified xml fragment.
Properties
AtomContentConstruct	Title `[get, set]`
	Gets or sets the title of the entry.
AtomLinkCollection	Links `[get]`
	Gets the links of the entry.
AtomPersonConstruct	Author `[get, set]`
	Gets or sets the author of the entry.
AtomPersonConstructCollection	Contributors `[get]`
	Gets the contributors of the entry.
Uri	Id `[get, set]`
	Gets or sets global unique identifier of the entry.
AtomDateConstruct	Modified `[get, set]`
	Gets or sets the last time when the entry has been modified.
AtomDateConstruct	Issued `[get, set]`
	Gets or sets the time when the entry has been issued.
AtomDateConstruct	Created `[get, set]`
	Gets or sets the time when the entry has been created.
AtomContentConstruct	Summary `[get, set]`
	Gets or sets the summary of the entry.
AtomContentCollection	Contents `[get]`
	Gets the contents of the entry.
Encoding	Encoding `[get, set]`
	Gets or sets the encoding of the entry.
ScopedElementCollection	AdditionalElements `[get]`
	Gets the additional elements of the entry.
override string	LocalName `[get]`
	Gets the local name of the entry element.
Uri	Uri `[get, set]`
	Gets or sets the uri of the atom entry if available, otherwise return null.

Detailed Description

The Atom entry.

See also:: AtomFeed

Constructor & Destructor Documentation

AtomEntry ( Uri ns )

Initialize a new instance of the AtomEntry class.

Member Function Documentation

override string ToString ( )

Converts the AtomEntry in a series of xml nodes.

Returns:: The string representation of AtomEntry class.

void Save ( Stream stream )

Saves the AtomEntry to the specified Stream.

Parameters:

stream

The Stream to write to.

Exceptions:

	ArgumentException	The encoding is not supported or the stream cannot be written to.
	ArgumentNullException	stream is null.
	RequiredElementNotFoundException	A required element is not found.
	InvalidOperationException	The internal writ

void Save ( string filename )

Saves the AtomEntry to the specified filename.

Exceptions:

	ArgumentException	The encoding is not supported; the filename is empty, contains only white space, or contains one or more invalid characters.
	UnauthorizedAccessException	Access is denied.
	ArgumentNullException	The filename is a null reference.
	DirectoryNotFoundException	The directory to write to is not found.
	IOException	The filename includes an incorrect or invalid syntax for file name, directory name, or volume label syntax.
	System.Security.SecurityException	The caller does not have the required permission.

Parameters:

filename

The file name to write to.

void Save ( TextWriter tw )

Saves the AtomEntry to the specified TextWriter.

Parameters:

The TextWriter to write to.

void Save ( XmlWriter xw )

Saves the AtomEntry to the specified TextWriter.

Parameters:

The XmlWriter to write to.

void Save ( WebResponse response )

Saves the AtomEntry to the specified WebResponse.

Parameters:

response

The HttpWebResponse to write to.

static AtomEntry Load	(	string	uri,
		Uri	ns
	)			`[static]`

Loads the AtomEntry from the specified URI.

Returns:: An AtomEntry instance.

Parameters:

uri

The URI of the resource containing the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

static AtomEntry Load	(	Uri	uri,
		Uri	ns
	)			`[static]`

Loads the AtomEntry from the specified System.Uri.

Returns:: An AtomEntry instance.

Parameters:

uri

The URI of the resource containing the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

static AtomEntry Load	(	Stream	stream,
		Uri	ns
	)			`[static]`

Loads the AtomEntry from the specified Stream.

Returns:: An AtomEntry instance.

Parameters:

stream

The Stream containing the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

static AtomEntry Load	(	TextReader	tr,
		Uri	ns
	)			`[static]`

Loads the AtomEntry from the specified TextReader.

Returns:: An AtomEntry instance.

Parameters:

The TextReader from which read the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

static AtomEntry Load	(	WebRequest	request,
		Uri	ns
	)			`[static]`

Loads the AtomEntry from the specified WebRequest.

Returns:: An AtomEntry instance.

Parameters:

request

The HttpWebRequest from which read the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

static AtomEntry Load	(	XmlReader	reader,
		Uri	ns
	)			`[static]`

Loads the AtomEntry from the specified XmlReader.

Returns:: An AtomEntry instance.

Parameters:

reader

The XmlReader from which read the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

static AtomEntry LoadXml	(	string	xmlFragment,
		Uri	ns
	)			`[static]`

Loads the AtomEntry from the specified xml fragment.

Returns:: An AtomEntry instance.

Parameters:

xmlFragment

The string containing the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

Property Documentation

AtomContentConstruct Title [get, set]

Gets or sets the title of the entry.

AtomLinkCollection Links [get]

Gets the links of the entry.

AtomPersonConstruct Author [get, set]

Gets or sets the author of the entry.

AtomPersonConstructCollection Contributors [get]

Gets the contributors of the entry.

Uri Id [get, set]

Gets or sets global unique identifier of the entry.

AtomDateConstruct Modified [get, set]

Gets or sets the last time when the entry has been modified.

AtomDateConstruct Issued [get, set]

Gets or sets the time when the entry has been issued.

AtomDateConstruct Created [get, set]

Gets or sets the time when the entry has been created.

AtomContentConstruct Summary [get, set]

Gets or sets the summary of the entry.

AtomContentCollection Contents [get]

Gets the contents of the entry.

Encoding Encoding [get, set]

Gets or sets the encoding of the entry.

ScopedElementCollection AdditionalElements [get]

Gets the additional elements of the entry.

override string LocalName [get]

Gets the local name of the entry element.

Reimplemented from AtomElement.

Uri Uri [get, set]

Gets or sets the uri of the atom entry if available, otherwise return null.

The documentation for this class was generated from the following file:

AtomEntry.cs

AtomEntry Class Reference

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation