View Javadoc
1   /**
2    * Redistribution and use of this software and associated documentation ("Software"), with or
3    * without modification, are permitted provided that the following conditions are met:
4    *
5    * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
6    * must also contain a copy of this document.
7    *
8    * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
9    * conditions and the following disclaimer in the documentation and/or other materials provided with
10   * the distribution.
11   *
12   * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
13   * without prior written permission of Intalio, Inc. For written permission, please contact
14   * info@exolab.org.
15   *
16   * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
17   * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
18   * Intalio, Inc.
19   *
20   * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
21   *
22   * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
23   * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
24   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
25   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
29   * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30   *
31   * Copyright 2002 (C) Intalio, Inc. All Rights Reserved.
32   *
33   * $Id$
34   */
35  
36  package org.exolab.castor.xml;
37  
38  
39  /**
40   * An interface to allow external "listening" to objects when they are being marshalled for various
41   * tracking purposes and potential modification, and to prevent an object from being marshalled if
42   * necessary. An implementation of this interface may be registered with the Marshaller.
43   *
44   * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
45   * @author <a href="mailto:Jeff.Norris@jpl.nasa.gov">Jeff Norris</a>
46   * @version $Revision$ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
47   **/
48  public interface MarshalListener {
49  
50    /**
51     * This method is called before an object is to be marshalled.
52     * 
53     * In case of unchecked exceptions being thrown, those will be caught and logged, but the
54     * marshalling process will not be interrupted.
55     *
56     * @param object the Object about to be marshalled.
57     * @return false if the object should not be marshalled.
58     **/
59    public boolean preMarshal(Object object);
60  
61    /**
62     * This method is called after an object has been marshalled. If #preMarshal returned false for a
63     * given Object, this method will not be called for that Object as marshalling will not take
64     * place.
65     *
66     * In case of unchecked exceptions being thrown, those will be caught and logged, but the
67     * marshalling process will not be interrupted.
68     *
69     * @param object the Object that was marshalled.
70     **/
71    public void postMarshal(Object object);
72  
73  } // -- MarshalListener