blob: db076fe803d9d3facc01cabd2f753e568e603467 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
/*
* Sonar, open source software quality management tool.
* Copyright (C) 2009 SonarSource SA
* mailto:contact AT sonarsource DOT com
*
* Sonar is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* Sonar is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sonar; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
*/
package org.sonar.api.project;
import org.apache.commons.configuration.Configuration;
import java.io.File;
import java.util.List;
/**
* Defines project in a form suitable for Sonar.
* This is a part of bootstrap process, so we should take care about backward compatibility.
* <p>
* We assume that project is just a set of configuration properties and directories. And each project has unique key in format
* "groupId:artifactId" (for example "org.codehaus.sonar:sonar").
* </p>
*
* @since 2.6
*/
public interface ProjectDefinition {
/**
* @return project key.
*/
String getKey();
/**
* @return project properties.
*/
Configuration getConfiguration();
/**
* @return Sonar working directory.
* It's "${project.build.directory}/sonar" ("${project.basedir}/target/sonar") for Maven projects.
*/
File getSonarWorkingDirectory();
/**
* @return project root directory.
* It's "${project.basedir}" for Maven projects.
*/
File getBasedir();
/**
* @return project directories.
*/
List<ProjectDirectory> getDirs();
/**
* @return parent project.
*/
ProjectDefinition getParent();
/**
* @return list of sub-projects.
*/
List<ProjectDefinition> getModules();
}
|
