org.sonar.api.batch.bootstrap
Class ProjectDefinition

java.lang.Object
  extended by org.sonar.api.batch.bootstrap.ProjectDefinition

public class ProjectDefinition
extends Object

Defines project metadata (key, name, source directories, ...). It's generally used by the extension point and must not be used by other standard extensions.

Since:
2.9

Field Summary
static String BINARIES_PROPERTY
          Deprecated. since 4.5.1 use SonarQube Java specific API
static String BUILD_DIR_PROPERTY
           
static String LIBRARIES_PROPERTY
          Deprecated. since 4.5.1 use SonarQube Java specific API
static String SOURCE_DIRS_PROPERTY
          Deprecated. since 4.5 use SOURCES_PROPERTY
static String SOURCE_FILES_PROPERTY
          Deprecated. since 4.5 use SOURCES_PROPERTY
static String SOURCES_PROPERTY
           
static String TEST_DIRS_PROPERTY
          Deprecated. since 4.5 use TESTS_PROPERTY
static String TEST_FILES_PROPERTY
          Deprecated. since 4.5 use TESTS_PROPERTY
static String TESTS_PROPERTY
           
 
Method Summary
 ProjectDefinition addBinaryDir(File f)
          Deprecated. since 4.5.1 use SonarQube Java specific API
 ProjectDefinition addBinaryDir(String path)
          Deprecated. since 4.5.1 use SonarQube Java specific API
 ProjectDefinition addContainerExtension(Object extension)
          Adds an extension, which would be available in PicoContainer during analysis of this project.
 void addLibrary(String path)
          Deprecated. since 4.5.1 use SonarQube Java specific API
 ProjectDefinition addSourceDirs(File... dirs)
          Deprecated. since 4.5 use addSources(File...)
 ProjectDefinition addSourceDirs(String... paths)
          Deprecated. since 4.5 use addSources(String...)
 ProjectDefinition addSourceFiles(File... files)
          Deprecated. since 4.5 use addSources(File...)
 ProjectDefinition addSourceFiles(String... paths)
          Deprecated. since 4.5 use addSources(File...)
 ProjectDefinition addSources(File... fileOrDirs)
           
 ProjectDefinition addSources(String... paths)
           
 ProjectDefinition addSubProject(ProjectDefinition child)
           
 ProjectDefinition addTestDirs(File... dirs)
          Deprecated. since 4.5 use addTests(File...)
 ProjectDefinition addTestDirs(String... paths)
          Deprecated. since 4.5 use addTests(String...)
 ProjectDefinition addTestFiles(File... files)
          Deprecated. since 4.5 use addTests(File...)
 ProjectDefinition addTestFiles(String... paths)
          Deprecated. since 4.5 use addTests(String...)
 ProjectDefinition addTests(File... fileOrDirs)
           
 ProjectDefinition addTests(String... paths)
           
static ProjectDefinition create()
           
static ProjectDefinition create(Properties properties)
          Deprecated. in 2.12, because it uses external object to represent internal state. To ensure backward-compatibility with Ant task this method cannot clone properties, so other callers must explicitly make clone of properties before passing into this method. Thus better to use create() with combination of other methods like setProperties(Properties) and setProperty(String, String).
 boolean equals(Object o)
           
 File getBaseDir()
           
 List<String> getBinaries()
          Deprecated. since 4.5.1 use SonarQube Java specific API
 File getBuildDir()
           
 List<Object> getContainerExtensions()
           
 String getDescription()
           
 String getKey()
           
 String getKeyWithBranch()
           
 List<String> getLibraries()
          Deprecated. since 4.5.1 use SonarQube Java specific API
 String getName()
           
 ProjectDefinition getParent()
           
 Properties getProperties()
           
 List<String> getSourceDirs()
          Deprecated. since 4.5 use sources()
 List<String> getSourceFiles()
          Deprecated. since 4.5 use sources()
 List<ProjectDefinition> getSubProjects()
           
 List<String> getTestDirs()
          Deprecated. since 4.5 use tests()
 List<String> getTestFiles()
          Deprecated. since 4.5 use tests()
 String getVersion()
           
 File getWorkDir()
           
 int hashCode()
           
 void remove()
           
 ProjectDefinition resetSourceDirs()
          Deprecated. since 4.5 use resetSources()
 ProjectDefinition resetSources()
           
 ProjectDefinition resetTestDirs()
          Deprecated. since 4.5 use resetTests()
 ProjectDefinition resetTests()
           
 ProjectDefinition setBaseDir(File baseDir)
           
 ProjectDefinition setBuildDir(File d)
           
 ProjectDefinition setDescription(String s)
           
 ProjectDefinition setKey(String key)
           
 ProjectDefinition setName(String s)
           
 ProjectDefinition setProperties(Properties properties)
          Copies specified properties into this object.
 ProjectDefinition setProperty(String key, String value)
           
 ProjectDefinition setSourceDirs(File... dirs)
          Deprecated. since 4.5 use setSources(File...)
 ProjectDefinition setSourceDirs(String... paths)
          Deprecated. since 4.5 use setSources(String...)
 ProjectDefinition setSources(File... filesOrDirs)
           
 ProjectDefinition setSources(String... paths)
           
 ProjectDefinition setTestDirs(File... dirs)
          Deprecated. since 4.5 use setTests(File...)
 ProjectDefinition setTestDirs(String... paths)
          Deprecated. since 4.5 use setTests(String...)
 ProjectDefinition setTests(File... fileOrDirs)
           
 ProjectDefinition setTests(String... paths)
           
 ProjectDefinition setVersion(String s)
           
 ProjectDefinition setWorkDir(File workDir)
           
 List<String> sources()
           
 List<String> tests()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SOURCES_PROPERTY

public static final String SOURCES_PROPERTY
See Also:
Constant Field Values

SOURCE_DIRS_PROPERTY

@Deprecated
public static final String SOURCE_DIRS_PROPERTY
Deprecated. since 4.5 use SOURCES_PROPERTY
See Also:
Constant Field Values

SOURCE_FILES_PROPERTY

@Deprecated
public static final String SOURCE_FILES_PROPERTY
Deprecated. since 4.5 use SOURCES_PROPERTY
See Also:
Constant Field Values

TESTS_PROPERTY

public static final String TESTS_PROPERTY
See Also:
Constant Field Values

TEST_DIRS_PROPERTY

@Deprecated
public static final String TEST_DIRS_PROPERTY
Deprecated. since 4.5 use TESTS_PROPERTY
See Also:
Constant Field Values

TEST_FILES_PROPERTY

@Deprecated
public static final String TEST_FILES_PROPERTY
Deprecated. since 4.5 use TESTS_PROPERTY
See Also:
Constant Field Values

BINARIES_PROPERTY

@Deprecated
public static final String BINARIES_PROPERTY
Deprecated. since 4.5.1 use SonarQube Java specific API
See Also:
Constant Field Values

LIBRARIES_PROPERTY

@Deprecated
public static final String LIBRARIES_PROPERTY
Deprecated. since 4.5.1 use SonarQube Java specific API
See Also:
Constant Field Values

BUILD_DIR_PROPERTY

public static final String BUILD_DIR_PROPERTY
See Also:
Constant Field Values
Method Detail

create

@Deprecated
public static ProjectDefinition create(Properties properties)
Deprecated. in 2.12, because it uses external object to represent internal state. To ensure backward-compatibility with Ant task this method cannot clone properties, so other callers must explicitly make clone of properties before passing into this method. Thus better to use create() with combination of other methods like setProperties(Properties) and setProperty(String, String).


create

public static ProjectDefinition create()

setBaseDir

public ProjectDefinition setBaseDir(File baseDir)

getBaseDir

public File getBaseDir()

setWorkDir

public ProjectDefinition setWorkDir(@Nullable
                                    File workDir)

getWorkDir

@CheckForNull
public File getWorkDir()

setBuildDir

public ProjectDefinition setBuildDir(@Nullable
                                     File d)

getBuildDir

@CheckForNull
public File getBuildDir()

getProperties

public Properties getProperties()

setProperties

public ProjectDefinition setProperties(Properties properties)
Copies specified properties into this object.

Since:
2.12

setProperty

public ProjectDefinition setProperty(String key,
                                     String value)

setKey

public ProjectDefinition setKey(String key)

setVersion

public ProjectDefinition setVersion(String s)

setName

public ProjectDefinition setName(String s)

setDescription

public ProjectDefinition setDescription(String s)

getKey

public String getKey()

getKeyWithBranch

public String getKeyWithBranch()
Since:
4.5

getVersion

public String getVersion()

getName

public String getName()

getDescription

public String getDescription()

sources

public List<String> sources()
Returns:
Source files and folders.

getSourceDirs

@Deprecated
public List<String> getSourceDirs()
Deprecated. since 4.5 use sources()


addSources

public ProjectDefinition addSources(String... paths)
Parameters:
paths - paths to file or directory with main sources. They can be absolute or relative to project base directory.

addSourceDirs

@Deprecated
public ProjectDefinition addSourceDirs(String... paths)
Deprecated. since 4.5 use addSources(String...)


addSources

public ProjectDefinition addSources(File... fileOrDirs)

addSourceDirs

@Deprecated
public ProjectDefinition addSourceDirs(File... dirs)
Deprecated. since 4.5 use addSources(File...)


resetSources

public ProjectDefinition resetSources()

resetSourceDirs

@Deprecated
public ProjectDefinition resetSourceDirs()
Deprecated. since 4.5 use resetSources()


setSources

public ProjectDefinition setSources(String... paths)

setSourceDirs

@Deprecated
public ProjectDefinition setSourceDirs(String... paths)
Deprecated. since 4.5 use setSources(String...)


setSources

public ProjectDefinition setSources(File... filesOrDirs)

setSourceDirs

@Deprecated
public ProjectDefinition setSourceDirs(File... dirs)
Deprecated. since 4.5 use setSources(File...)


addSourceFiles

@Deprecated
public ProjectDefinition addSourceFiles(String... paths)
Deprecated. since 4.5 use addSources(File...)


addSourceFiles

@Deprecated
public ProjectDefinition addSourceFiles(File... files)
Deprecated. since 4.5 use addSources(File...)


getSourceFiles

@Deprecated
public List<String> getSourceFiles()
Deprecated. since 4.5 use sources()


tests

public List<String> tests()

getTestDirs

@Deprecated
public List<String> getTestDirs()
Deprecated. since 4.5 use tests()


addTests

public ProjectDefinition addTests(String... paths)
Parameters:
paths - path to files or directories with test sources. It can be absolute or relative to project directory.

addTestDirs

@Deprecated
public ProjectDefinition addTestDirs(String... paths)
Deprecated. since 4.5 use addTests(String...)


addTests

public ProjectDefinition addTests(File... fileOrDirs)

addTestDirs

@Deprecated
public ProjectDefinition addTestDirs(File... dirs)
Deprecated. since 4.5 use addTests(File...)


setTests

public ProjectDefinition setTests(String... paths)

setTestDirs

@Deprecated
public ProjectDefinition setTestDirs(String... paths)
Deprecated. since 4.5 use setTests(String...)


setTests

public ProjectDefinition setTests(File... fileOrDirs)

setTestDirs

@Deprecated
public ProjectDefinition setTestDirs(File... dirs)
Deprecated. since 4.5 use setTests(File...)


resetTests

public ProjectDefinition resetTests()

resetTestDirs

@Deprecated
public ProjectDefinition resetTestDirs()
Deprecated. since 4.5 use resetTests()


addTestFiles

@Deprecated
public ProjectDefinition addTestFiles(String... paths)
Deprecated. since 4.5 use addTests(String...)


addTestFiles

@Deprecated
public ProjectDefinition addTestFiles(File... files)
Deprecated. since 4.5 use addTests(File...)


getTestFiles

@Deprecated
public List<String> getTestFiles()
Deprecated. since 4.5 use tests()


getBinaries

@Deprecated
public List<String> getBinaries()
Deprecated. since 4.5.1 use SonarQube Java specific API


addBinaryDir

@Deprecated
public ProjectDefinition addBinaryDir(String path)
Deprecated. since 4.5.1 use SonarQube Java specific API

Parameters:
path - path to directory with compiled source. In case of Java this is directory with class files. It can be absolute or relative to project directory.

addBinaryDir

@Deprecated
public ProjectDefinition addBinaryDir(File f)
Deprecated. since 4.5.1 use SonarQube Java specific API


getLibraries

@Deprecated
public List<String> getLibraries()
Deprecated. since 4.5.1 use SonarQube Java specific API


addLibrary

@Deprecated
public void addLibrary(String path)
Deprecated. since 4.5.1 use SonarQube Java specific API

Parameters:
path - path to file with third-party library. In case of Java this is path to jar file. It can be absolute or relative to project directory.

addContainerExtension

public ProjectDefinition addContainerExtension(Object extension)
Adds an extension, which would be available in PicoContainer during analysis of this project.

Since:
2.8

getContainerExtensions

public List<Object> getContainerExtensions()
Since:
2.8

addSubProject

public ProjectDefinition addSubProject(ProjectDefinition child)
Since:
2.8

getParent

public ProjectDefinition getParent()

remove

public void remove()

getSubProjects

public List<ProjectDefinition> getSubProjects()
Since:
2.8

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright © 2009–2016 SonarSource. All rights reserved.