KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jibx > runtime > IMarshallable


1 /*
2 Copyright (c) 2002,2003, Dennis M. Sosnoski.
3 All rights reserved.
4
5 Redistribution and use in source and binary forms, with or without modification,
6 are permitted provided that the following conditions are met:
7
8  * Redistributions of source code must retain the above copyright notice, this
9    list of conditions and the following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright notice,
11    this list of conditions and the following disclaimer in the documentation
12    and/or other materials provided with the distribution.
13  * Neither the name of JiBX nor the names of its contributors may be used
14    to endorse or promote products derived from this software without specific
15    prior written permission.
16
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
21 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 package org.jibx.runtime;
30
31 /**
32  * Marshallable interface definition. This interface must be implemented by all
33  * classes which can be marshalled as independent units (not just as children of
34  * other objects). Classes implementing this interface may either marshal
35  * themselves directly (if there's only one marshalling format defined), or
36  * obtain an instance of the appropriate marshaller from the context and use
37  * that. This interface is automatically added by the binding compiler to all
38  * classes targeted by <mapping> elements in a binding.
39  *
40  * @author Dennis M. Sosnoski
41  * @version 1.0
42  */
43
44 public interface IMarshallable
45 {
46     /**
47      * Get class index. This returns the mapping index number for a class within
48      * the compiled bindings. It's intended primarily for internal use by the
49      * binding framework.
50      *
51      * @return mapping index number
52      */
53      
54     public int JiBX_getIndex();
55     
56     /**
57      * Marshal self. This method call is responsible for all handling of the
58      * marshalling of an object to XML text.
59      *
60      * @param ctx marshalling context
61      * @throws JiBXException on error in marshalling process
62      */
63      
64     public void marshal(IMarshallingContext ctx) throws JiBXException;
65 }
66
Popular Tags