001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.cnd.repository.api;
043:
044: import java.util.Set;
045: import org.netbeans.modules.cnd.repository.spi.Key;
046: import org.netbeans.modules.cnd.repository.spi.Persistent;
047: import org.netbeans.modules.cnd.repository.spi.RepositoryListener;
048:
049: /**
050: *
051: * @author Sergey Grinev
052: */
053: public interface Repository {
054: /**
055: * store object without option to be persistent,
056: * either to register object for later put
057: * or to store temporary inpersistable object
058: * @param key the key
059: * @param obj the object to store
060: */
061: void hang(Key key, Persistent obj);
062:
063: /**
064: * store object
065: * @param key the key
066: * @param obj the object to store
067: */
068: void put(Key key, Persistent obj);
069:
070: /**
071: * retrieve object
072: * @param key the key of object to get
073: * @return an object corresponding to key or null if there is no such one
074: */
075: Persistent get(Key key);
076:
077: /**
078: * retrieve object if it resides in memory cache;
079: * @param key the key of object to get
080: * @return an object corresponding to key or null if there is no such object in memory cache
081: */
082: Persistent tryGet(Key key);
083:
084: /**
085: * stop storing object
086: * @param key the key of object to remove
087: */
088: void remove(Key key);
089:
090: /**
091: * store all objects to permanent location
092: * should be called during IDE shutdown
093: */
094: void debugClear();
095:
096: /**
097: * Prepare repositoty and tells the version of the persistent mechanism
098: * @param verison
099: */
100: void startup(int persistMechanismVersion);
101:
102: /**
103: * Shuts down repository.
104: * Should be called during application shutdown
105: */
106: void shutdown();
107:
108: /**
109: * Opens repository unit
110: * @param unitName the unique identifier of the unit to open
111: */
112: void openUnit(String unitName);
113:
114: /**
115: * Close Repository Unit, e.g. Project for IDE
116: * @param unitName the name of unit
117: */
118: void closeUnit(String unitName, boolean cleanRepository,
119: Set<String> requiredUnits);
120:
121: /**
122: * Removes repository unit from disk
123: */
124: void removeUnit(String unitName);
125:
126: /**
127: * clean the disk caches of all repositories
128: */
129: void cleanCaches();
130:
131: /**
132: * add a listener to the repository
133: * @param aListener the listener
134: */
135: void registerRepositoryListener(final RepositoryListener aListener);
136:
137: /**
138: * remove a listener from the repository
139: * @param aListener the listener
140: */
141: void unregisterRepositoryListener(final RepositoryListener aListener);
142:
143: }
|