+Show TOC
×Hide TOC

IXMLToObjectSerializer

Kind of class:	interface
Inherits from:	none
Implemented by:	XMLToObjectSerializer
Version:	1.0
Author:	Romain Ecarnot
Classpath:	com.bourre.data.libs.IXMLToObjectSerializer
File last modified:	Wednesday, 31 October 2007, 07:35:29

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
/**
 * {@code IXMLToObjectSerializer } interface defines basic rules for 
 * concrete XML serializer.
 *
 * @author Romain Ecarnot
 * @version 1.0
 */
interface com.bourre.data.libs.IXMLToObjectSerializer
{
    /**
     * Serialzes passed-in {@code instance} into XML structure.
     * 
     * <p>Use {@code instanceName} to named your object (optional)
     * 
     * @param instance Instance to serialize
     * @param instanceName (optional) Instance's name (name of first xml node)
     */
    public function serialize( instance, instanceName : String ) : XML;
}

IXMLToObjectSerializer interface defines basic rules for
concrete XML serializer.

Summary

Instance methods

serialize

Instance methods

serialize

function serialize (

instanceName:String) : XML

Serialzes passed-in instance into XML structure.

Use instanceName to named your object (optional)

Parameters:

instance :

Instance to serialize

instanceName:

(optional) Instance's name (name of first xml node)