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 1999 (C) Intalio, Inc. All Rights Reserved. 32 * 33 * $Id: CastorTestable.java 6785 2007-01-29 05:09:59Z ekuns $ 34 */ 35 package org.castor.xmlctf; 36 37 /** 38 * Every root object in an object model used in a tests has to implement this interface as well as 39 * to override the equals() method. It can be useful that all the objects in an object model used 40 * for tests implement this interface. 41 * 42 * @author <a href="mailto:gignoux@intalio.com">Sebastien Gignoux</a> 43 * @version $Revision: 6785 $ $Date: 2003-10-15 09:17:49 -0600 (Wed, 15 Oct 2003) $ 44 */ 45 public interface CastorTestable { 46 47 /** 48 * Returns a recursive dump of the contents of the object's fields in a user readable format. This 49 * is used to retrieve the state of the object if castor fails to marshal the object for any 50 * reason. 51 * <p> 52 * We don't rely on the {@link java.lang.Object#toString()} function as might be implemented with 53 * another semantic. 54 * 55 * @return a recursive dump of the contents of the object's fields in a user readable format. 56 */ 57 public String dumpFields(); 58 59 /** 60 * Randomizes the contents of the fields of this instance. This is used to create an instance of 61 * the object model whithout having to unmarshal anything. 62 * 63 * @throws InstantiationException if this method is called for an Interface or abstract class 64 * @throws IllegalAccessException if this method is not accessible 65 */ 66 public void randomizeFields() throws InstantiationException, IllegalAccessException; 67 68 }