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-2006 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.spi.mobility.cfgfactory;
043:
044: import java.util.List;
045: import java.util.Map;
046:
047: /**
048: * ProjectConfigurationFactory provides tree of categories and project configuration templates.<br>
049: * User can select from the tree during each new project configuration creation.
050: * Selected configuration template(s) then provide information for the newly created project configuration(s).
051: * If you want to plug a custom device database provider then this is your entry point.
052: * @author Adam Sotona
053: */
054: public interface ProjectConfigurationFactory {
055:
056: /**
057: * Getter of the root category descriptor.
058: * This descriptor describes the factory itself and works as its root node.
059: * @return CategoryDescriptor root node descriptor
060: */
061: public CategoryDescriptor getRootCategory();
062:
063: /**
064: * Abstract descriptor interface. do not implement directly.
065: * Use CategoryDescriptor or ConfigurationTemplateDescriptor instead.
066: */
067: static abstract interface Descriptor {
068: /**
069: * Display name of the descriptor (category or cfg template name).
070: * @return String display name
071: */
072: public String getDisplayName();
073: }
074:
075: /**
076: * Describes category node of the tree.
077: * Each category can include multiple subcategories and/or configuration templates.
078: */
079: public static interface CategoryDescriptor extends Descriptor {
080: /**
081: * Getter for list of category children.
082: * @return non-null list of Descriptors
083: */
084: public List<Descriptor> getChildren();
085: }
086:
087: /**
088: * Describes Project Configuration Template.
089: */
090: public static interface ConfigurationTemplateDescriptor extends
091: Descriptor {
092: /**
093: * Getter for the new project configuration name.
094: * The project configuration name must be a valid Java identifier.
095: * @return String new project configuration name
096: */
097: public String getCfgName();
098:
099: /**
100: * Getter for project properties that will be specific to the project configuration.
101: * @return String-String Map of project properties or null
102: */
103: public Map<String, String> getProjectConfigurationProperties();
104:
105: /**
106: * Getter for properties that will added to project properties without configuration prefix (for example relative references, etc...).
107: * @return String-String Map of project properties or null
108: */
109: public Map<String, String> getProjectGlobalProperties();
110:
111: /**
112: * Getter for properties that will added to project private properties without configuration prefix (for example absolute references, etc...).
113: * @return String-String Map of private properties or null
114: */
115: public Map<String, String> getPrivateProperties();
116: }
117: }
|