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-2006 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: package org.netbeans.modules.vmd.api.model;
42:
43: /**
44: * This interface represents a version resolver. It is used e.g. in PropertyDescriptor to describe availability of
45: * a property in a particular state of a document.
46: *
47: * @author David Kaspar
48: */
49: public interface Versionable {
50:
51: /**
52: * Represents a Versionable which is always available. Often used as a default behaviour.
53: */
54: public static final Versionable FOREVER = new Versionable() {
55:
56: public boolean isCompatibleWith(Versionable versionable) {
57: return true;
58: }
59:
60: public boolean isAvailable(DesignDocument document) {
61: return true;
62: }
63:
64: };
65:
66: /**
67: * Checks whether this version is allowed within a specified version.
68: * Version1.isCompatibleWith(Version2)==true.
69: * Version2.isCompatibleWith(Version1)==false.
70: * @param versionable the versionable
71: * @return true, if compatible; false otherwise
72: */
73: boolean isCompatibleWith(Versionable versionable);
74:
75: /**
76: * Called to resolve whether the version, which is represented by implementation of this interface, is available
77: * for the currect state of a specified document.
78: * @param document the document
79: * @return true, if the version is available
80: */
81: boolean isAvailable(DesignDocument document);
82:
83: }
|