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.discovery.api;
043:
044: import java.util.List;
045:
046: /**
047: *
048: * @author Alexander Simon
049: */
050: public interface DiscoveryProvider {
051:
052: /**
053: * Returns provider ID
054: */
055: String getID();
056:
057: /**
058: * Returns provider name
059: */
060: String getName();
061:
062: /**
063: * Returns provider description
064: */
065: String getDescription();
066:
067: /**
068: * Returns property keys of additional information for provider
069: */
070: List<String> getPropertyKeys();
071:
072: /**
073: * Returns property of additional information for provider
074: */
075: ProviderProperty getProperty(String key);
076:
077: /**
078: * Clean provider state
079: */
080: void clean();
081:
082: /**
083: * Is analyzer applicable to project
084: */
085: boolean isApplicable(ProjectProxy project);
086:
087: /**
088: * Can analyze project. Returns weight of assurance of results.
089: * Results range is [0,100].
090: * 0 provider is not sure about results at all
091: * 100 provider is sure about results
092: */
093: int canAnalyze(ProjectProxy project);
094:
095: /**
096: * Analyze project and returns list of configuration
097: */
098: List<Configuration> analyze(ProjectProxy project);
099:
100: /**
101: * Stop analyzing.
102: */
103: void stop();
104: }
|