KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > db4o > config > ObjectConstructor


1 /* Copyright (C) 2004 - 2006 db4objects Inc. http://www.db4o.com
2
3 This file is part of the db4o open source object database.
4
5 db4o is free software; you can redistribute it and/or modify it under
6 the terms of version 2 of the GNU General Public License as published
7 by the Free Software Foundation and as clarified by db4objects' GPL
8 interpretation policy, available at
9 http://www.db4o.com/about/company/legalpolicies/gplinterpretation/
10 Alternatively you can write to db4objects, Inc., 1900 S Norfolk Street,
11 Suite 350, San Mateo, CA 94403, USA.
12
13 db4o is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 for more details.
17
18 You should have received a copy of the GNU General Public License along
19 with this program; if not, write to the Free Software Foundation, Inc.,
20 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */

21 package com.db4o.config;
22
23 import com.db4o.*;
24
25 /**
26  * interface to allow instantiating objects by calling specific constructors.
27  * <br><br><b>Examples: ../com/db4o/samples/translators.</b><br><br>
28  * By writing classes that implement this interface, it is possible to
29  * define which constructor is to be used during the instantiation of a stored object.
30  * <br><br>
31  * Before starting a db4o session, translator classes that implement the
32  * <code>ObjectConstructor</code> or
33  * {@link ObjectTranslator ObjectTranslator}
34  * need to be registered.<br><br>
35  * Example:<br>
36  * <code>
37  * Configuration config = Db4o.configure();<br>
38  * ObjectClass oc = config.objectClass("package.className");<br>
39  * oc.translate(new FooTranslator());</code><br><br>
40  */

41 public interface ObjectConstructor extends ObjectTranslator {
42
43     /**
44      * db4o calls this method when a stored object needs to be instantiated.
45      * <br><br>
46      * @param container the ObjectContainer used
47      * @param storedObject the object stored with
48      * {@link ObjectTranslator#onStore ObjectTranslator.onStore}.
49      * @return the instantiated object.
50      */

51     public Object JavaDoc onInstantiate(ObjectContainer container, Object JavaDoc storedObject);
52     
53 }
Popular Tags