KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > j2ee > dd > impl > common > DDProviderDataObject


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19 package org.netbeans.modules.j2ee.dd.impl.common;
20
21 import org.openide.filesystems.FileLock;
22 import org.netbeans.modules.j2ee.dd.api.common.RootInterface;
23
24 import java.io.IOException JavaDoc;
25 import java.io.Reader JavaDoc;
26
27 /**
28  * @author pfiala
29  */

30 public interface DDProviderDataObject {
31     /**
32      * Provides Reader to save binary data.
33      * @return the Reader
34      * @throws IOException
35      */

36     Reader JavaDoc createReader() throws IOException JavaDoc;
37
38     /**
39      * Locks binary data if possible.
40      * @return the data lock
41      */

42     FileLock getDataLock();
43
44     /**
45      * Writes data from model to the cache and saves the data if needed.
46      * @param model
47      * @param dataLock
48      */

49     void writeModel(RootInterface model, FileLock dataLock);
50
51     /**
52      * Obtains data lock, writes data from model to the cache and saves the data if needed.
53      * Finally releases the lock.
54      * @param model
55      */

56     void writeModel(RootInterface model) throws IOException JavaDoc;
57 }
58
Popular Tags