01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.modules.cnd.repository.spi;
43:
44: /**
45: * interface for repository keys, must be implemented in client of repository
46: * @author Sergey Grinev, Vladimir Voskresensky
47: */
48: public interface Key {
49: /** returns associated factory
50: * @return associated factory
51: */
52: PersistentFactory getPersistentFactory();
53:
54: /** return a unit which serves as a sign of global set of keys, e.g.,
55: * projects in the IDE
56: * @return the unit
57: */
58: CharSequence getUnit();
59:
60: /** Behaviors allow repository to optimize
61: * storaging files
62: */
63: enum Behavior {
64: Default, // default behavior
65: LargeAndMutable
66: // mutable object; tends to change it's state *a lot*
67: }
68:
69: /** returns behavior of the object
70: * @return key Behavior
71: */
72: Behavior getBehavior();
73:
74: /** returns depth of primary key's hierarchy *
75: * @return depth of primary key's hierarchy
76: */
77: int getDepth();
78:
79: /** returns n-th element of primary hierarchy *
80: * @param level n
81: * @return n-th primary element
82: */
83: CharSequence getAt(int level);
84:
85: /** returns depth of secondary key's hierarchy *
86: * @return secondary depth
87: */
88: int getSecondaryDepth();
89:
90: /** returns n-th element of secondary hierarchy *
91: * @param level n
92: * @return n-th secondary element
93: */
94: int getSecondaryAt(int level);
95: }
|