KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > dom4j > jaxb > JAXBObjectModifier


1 /*
2  * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
3  *
4  * This software is open source.
5  * See the bottom of this file for the licence.
6  */
7
8 package org.dom4j.jaxb;
9
10 import javax.xml.bind.Element;
11
12 /**
13  * JAXBObjectHandler implementations can be registered with the {@link
14  * JAXBModifier} in order to change unmarshalled XML fragments.
15  *
16  * @author Wonne Keysers (Realsoftware.be)
17  */
18 public interface JAXBObjectModifier {
19     /**
20      * Called when the {@link JAXBModifier}has finished parsing the xml path
21      * the handler was registered for. The provided object is the unmarshalled
22      * representation of the XML fragment. It can be casted to the appropriate
23      * implementation class that is generated by the JAXB compiler. <br>
24      * The modified JAXB element that returns from this method will be
25      * marshalled by the {@link JAXBModifier}and put in the DOM4J tree.
26      *
27      * @param jaxbElement
28      * the JAXB object to be modified
29      *
30      * @return the modified JAXB object, or null when it must be removed.
31      *
32      * @throws Exception
33      * possibly thrown by the implementation.
34      */
35     Element modifyObject(Element jaxbElement) throws Exception JavaDoc;
36 }
37
38 /*
39  * Redistribution and use of this software and associated documentation
40  * ("Software"), with or without modification, are permitted provided that the
41  * following conditions are met:
42  *
43  * 1. Redistributions of source code must retain copyright statements and
44  * notices. Redistributions must also contain a copy of this document.
45  *
46  * 2. Redistributions in binary form must reproduce the above copyright notice,
47  * this list of conditions and the following disclaimer in the documentation
48  * and/or other materials provided with the distribution.
49  *
50  * 3. The name "DOM4J" must not be used to endorse or promote products derived
51  * from this Software without prior written permission of MetaStuff, Ltd. For
52  * written permission, please contact dom4j-info@metastuff.com.
53  *
54  * 4. Products derived from this Software may not be called "DOM4J" nor may
55  * "DOM4J" appear in their names without prior written permission of MetaStuff,
56  * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
57  *
58  * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
59  *
60  * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
61  * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
62  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
63  * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
64  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
65  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
66  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
67  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
68  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
69  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
70  * POSSIBILITY OF SUCH DAMAGE.
71  *
72  * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
73  */
74
Popular Tags