KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > db4o > types > Db4oList


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.types;
22
23 /**
24  * db4o List implementation for database-aware lists.
25  * <br><br>
26  * A <code>Db4oList</code> supplies the methods specified in java.util.List.<br><br>
27  * All access to the list is controlled by the {@link com.db4o.ObjectContainer ObjectContainer} to help the
28  * programmer produce expected results with as little work as possible:<br>
29  * - newly added objects are automatically persisted.<br>
30  * - list elements are automatically activated when they are needed. The activation
31  * depth is configurable with {@link Db4oCollection#activationDepth(int)}.<br>
32  * - removed objects can be deleted automatically, if the list is configured
33  * with {@link Db4oCollection#deleteRemoved(boolean)}<br><br>
34  * Usage:<br>
35  * - declare a <code>java.util.List</code> variable on your persistent classes.<br>
36  * - fill this variable with a method in the ObjectContainer collection factory.<br><br>
37  * <b>Example:</b><br><br>
38  * <code>class MyClass{<br>
39  * &nbsp;&nbsp;List myList;<br>
40  * }<br><br>
41  * MyClass myObject = new MyClass();<br>
42  * myObject.myList = objectContainer.ext().collections().newLinkedList();
43  *
44  * @see com.db4o.ext.ExtObjectContainer#collections
45  *
46  * @sharpen.ignore
47  */

48 public interface Db4oList extends Db4oCollection {
49
50 }
51
Popular Tags