01: /*
02: Copyright (c) 2002,2003, Dennis M. Sosnoski.
03: All rights reserved.
04:
05: Redistribution and use in source and binary forms, with or without modification,
06: are permitted provided that the following conditions are met:
07:
08: * Redistributions of source code must retain the above copyright notice, this
09: 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: * Abstract base marshaller interface definition. This interface must be
33: * implemented by the handler for marshalling an object as an instance of a
34: * binding with extension mappings.<p>
35: *
36: * This extension to the normal marshaller interface allows the base
37: * marshalling to determine the proper marshaller implementation to use at
38: * runtime. The code needs to check that the object to be marshalled has a
39: * marshaller that extends this base mapping.
40: *
41: * @author Dennis M. Sosnoski
42: * @version 1.0
43: */
44:
45: public interface IAbstractMarshaller extends IMarshaller {
46: /**
47: * Marshal instance of class with mapping extending this abstract mapping.
48: * This method call is responsible for all handling of the marshalling of an
49: * appropriate object to XML text. It is called at the point where the start
50: * tag for the associated element should be generated.
51: *
52: * @param obj object to be marshalled (may be <code>null</code>, in the case
53: * of a non-optional property with no value supplied)
54: * @param ctx XML text output context
55: * @throws JiBXException on error in marshalling process
56: */
57:
58: public void baseMarshal(Object obj, IMarshallingContext ctx)
59: throws JiBXException;
60: }
|