1 /*
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Intalio, Inc. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Intalio, Inc. Exolab is a registered
23 * trademark of Intalio, Inc.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 1999 (C) Intalio, Inc. All Rights Reserved.
42 *
43 * $Id: CastorTestable.java 6785 2007-01-29 05:09:59Z ekuns $
44 */
45 package org.castor.xmlctf;
46
47 /**
48 * Every root object in an object model used in a tests has to implement this
49 * interface as well as to override the equals() method. It can be useful that
50 * all the objects in an object model used for tests implement this interface.
51 *
52 * @author <a href="mailto:gignoux@intalio.com">Sebastien Gignoux</a>
53 * @version $Revision: 6785 $ $Date: 2003-10-15 09:17:49 -0600 (Wed, 15 Oct 2003) $
54 */
55 public interface CastorTestable {
56
57 /**
58 * Returns a recursive dump of the contents of the object's fields in a user
59 * readable format. This is used to retrieve the state of the object if
60 * castor fails to marshal the object for any reason.
61 * <p>
62 * We don't rely on the {@link java.lang.Object#toString()} function as
63 * might be implemented with another semantic.
64 *
65 * @return a recursive dump of the contents of the object's fields in a user
66 * readable format.
67 */
68 public String dumpFields();
69
70 /**
71 * Randomizes the contents of the fields of this instance. This is used to
72 * create an instance of the object model whithout having to unmarshal
73 * anything.
74 *
75 * @throws InstantiationException if this method is called for an Interface
76 * or abstract class
77 * @throws IllegalAccessException if this method is not accessible
78 */
79 public void randomizeFields() throws InstantiationException, IllegalAccessException;
80
81 }