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: import java.util.Collection;
44: import java.util.Set;
45:
46: /**
47: * This inteface defines a version compatibility and convertions.
48: *
49: * @author David Kaspar
50: */
51: // TODO - partial semantic clash with Versionable interface
52: public interface VersionDescriptor {
53:
54: /**
55: * Checks whether this version is allowed within a specified version.
56: * Version1.isCompatibleWith(Version2)==true.
57: * Version2.isCompatibleWith(Version1)==false.
58: * @param descriptor the version descriptor
59: * @return true, if compatible; false otherwise
60: */
61: public boolean isCompatibleWith(VersionDescriptor descriptor);
62:
63: /**
64: * Return whether this version descriptor is compatible with abilities.
65: * @param abilities the collection of abilities
66: * @return true, if compatible
67: */
68: public boolean isCompatibleWith(Collection<String> abilities);
69:
70: /**
71: * Return a set of warning/error messages for notifying an user about conversion changes.
72: * This method is called before convertComponent method is called on any component in a document.
73: * @param component the component
74: * @param oldAbilities the collection of old abilities
75: * @param newAbilities the collection of new abilities
76: * @return a set of messages
77: */
78: // TODO - change this signature
79: public Set<String> getPreliminaryConvertMessages(
80: DesignComponent component, Collection<String> oldAbilities,
81: Collection<String> newAbilities);
82:
83: /**
84: * Convert a component.
85: * This method is called after getPreliminaryConvertMessages method is called on all components in a document.
86: * @param component the component
87: * @param oldAbilities the collection of old abilities
88: * @param newAbilities the collection of new abilities
89: */
90: // TODO - how to deal with deleting of unusable components
91: public void convertComponent(DesignComponent component,
92: Collection<String> oldAbilities,
93: Collection<String> newAbilities);
94:
95: }
|