Project (Sonar 2.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.sonar.api.resources
Class Project

java.lang.Object
  org.sonar.api.resources.Resource
      org.sonar.api.resources.Project

public class Project
extends Resource
extends Resource

A class that manipulates Projects in the Sonar way, i.e. mixing MavenProjects with the way it should be analyzed

Since:: 1.10

Nested Class Summary
`static class`	`Project.AnalysisType` Enumerates the type of possible analysis

Field Summary
`static String`	`PARAM_DATE` Deprecated. since version 1.11. Constant moved to CoreProperties
`static String`	`PARAM_DYNAMIC_ANALYSIS` Deprecated. since version 1.11. Constant moved to CoreProperties
`static String`	`PARAM_EXCLUSIONS` Deprecated. since version 1.11. Constant moved to CoreProperties
`static String`	`PARAM_LANGUAGE` Deprecated. since version 1.11. Constant moved to CoreProperties
`static String`	`PARAM_REUSE_RULES_CONFIG` Deprecated. since version 1.11. Constant moved to CoreProperties
`static String`	`PARAM_VERSION` Deprecated. since version 1.11. Constant moved to CoreProperties

Fields inherited from class org.sonar.api.resources.Resource
`QUALIFIER_CLASS, QUALIFIER_DIRECTORY, QUALIFIER_FIELD, QUALIFIER_FILE, QUALIFIER_LIB, QUALIFIER_METHOD, QUALIFIER_MODULE, QUALIFIER_PACKAGE, QUALIFIER_PROJECT, QUALIFIER_PROJECT_BRANCH, QUALIFIER_PROJECT_TRUNK, QUALIFIER_SUBVIEW, QUALIFIER_UNIT_TEST_CLASS, QUALIFIER_VIEW, SCOPE_DIRECTORY, SCOPE_ENTITY, SCOPE_FILE, SCOPE_PROJECT, SCOPE_SET, SCOPE_SPACE`

Constructor Summary
`Project(String key)`
`Project(String key, String branch, String name)`

Method Summary
`static Project`	`createFromMavenIds(String groupId, String artifactId)`
`Date`	`getAnalysisDate()`
`Project.AnalysisType`	`getAnalysisType()`
`String`	`getAnalysisVersion()`
`String`	`getArtifactId()` Used for Maven projects
`String`	`getBranch()`
`org.apache.commons.configuration.Configuration`	`getConfiguration()`
`String`	`getDescription()`
`String[]`	`getExclusionPatterns()` Patterns of resource exclusion as defined in project settings page.
`ProjectFileSystem`	`getFileSystem()`
`String`	`getGroupId()` Used for Maven projects
`Language`	`getLanguage()`
`String`	`getLanguageKey()`
`String`	`getLongName()`
`List<Project>`	`getModules()`
`String`	`getName()`
`String`	`getPackaging()`
`Project`	`getParent()` The parent is used to build the resources tree, for example for relations between classes, packages and projects.
`org.apache.maven.project.MavenProject`	`getPom()`
`Object`	`getProperty(String key)`
`String`	`getQualifier()`
`boolean`	`getReuseExistingRulesConfig()`
`Project`	`getRoot()`
`String`	`getScope()`
`boolean`	`isLatestAnalysis()` whether it's the latest analysis done on this project (displayed in sonar dashboard) or an analysis on a past revision.
`boolean`	`isModule()`
`boolean`	`isRoot()`
`boolean`	`matchFilePattern(String antPattern)` Check resource against an Ant pattern, like mypackag?/*Foo.java.
`void`	`removeFromParent()` For internal use only.
`Project`	`setAnalysisDate(Date analysisDate)` For internal use only.
`Project`	`setAnalysisType(Project.AnalysisType at)`
`Project`	`setAnalysisVersion(String analysisVersion)` For internal use only.
`Project`	`setBranch(String branch)`
`Project`	`setConfiguration(org.apache.commons.configuration.Configuration configuration)` Sets the configuration
`Project`	`setDescription(String description)`
`Project`	`setExclusionPatterns(String[] s)` Set exclusion patterns.
`Project`	`setFileSystem(ProjectFileSystem fs)`
`Project`	`setLanguage(Language language)`
`Project`	`setLanguageKey(String languageKey)` For internal use only.
`Project`	`setLatestAnalysis(boolean b)` For internal use only.
`Project`	`setName(String name)`
`Project`	`setPackaging(String packaging)`
`Project`	`setParent(Project parent)` For internal use only.
`Project`	`setPom(org.apache.maven.project.MavenProject pom)`
`String`	`toString()`

Methods inherited from class org.sonar.api.resources.Resource
`equals, getEffectiveKey, getId, getKey, hashCode, isExcluded, setEffectiveKey, setExcluded, setId, setKey`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail