eldonilo/lightstring: stanza.js annotate

annotate stanza.js @ 29:1e6d2ca2daae

Adds a Lightstring.Stanza object and use it.

author	Sonny Piers <sonny.piers@gmail.com>
date	Sat, 28 Jan 2012 04:34:30 +0100
parents
children	c06ec02217ee

rev	line source
29 1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	1 'use strict';
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	2
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	3 /**
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	4 Copyright (c) 2011, Sonny Piers <sonny at fastmail dot net>
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	5
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	6 Permission to use, copy, modify, and/or distribute this software for any
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	7 purpose with or without fee is hereby granted, provided that the above
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	8 copyright notice and this permission notice appear in all copies.
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	9
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	10 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	11 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	12 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	13 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	14 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	15 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	16 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	17 */
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	18
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	19
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	20 /**
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	21 * @constructor Creates a new Stanza object.
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	22 * @param {String\|Object} [aStanza] The XML or DOM content of the stanza
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	23 * @memberOf Lightstring
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	24 */
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	25 Lightstring.Stanza = function(aStanza) {
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	26 if (typeof aStanza === 'string') {
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	27 this.XML = aStanza;
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	28 this.DOM = Lightstring.XML2DOM(this.XML);
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	29 }
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	30 else if (aStanza instanceof Element) {
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	31 this.DOM = aStanza;
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	32 this.XML = Lightstring.DOM2XML(this.DOM);
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	33 }
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	34 //ToDo error ?
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	35 else {
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	36 return null;
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	37 }
1e6d2ca2daae Adds a Lightstring.Stanza object and use it. Sonny Piers <sonny.piers@gmail.com> parents: diff changeset	38 };