Uses of Class
org.sonar.api.resources.Resource

Packages that use Resource

Package	Description
org.sonar.api.batch
org.sonar.api.component
org.sonar.api.design
org.sonar.api.measures
org.sonar.api.resources
org.sonar.api.security

Uses of Resource in org.sonar.api.batch

Methods in org.sonar.api.batch with type parameters of type Resource

Modifier and Type	Method and Description
<R extends Resource> R	SensorContext.getResource(R reference) Search for an indexed resource.
abstract <R extends Resource> R	SonarIndex.getResource(R reference) Deprecated. Search for an indexed resource.

Methods in org.sonar.api.batch that return Resource

Modifier and Type	Method and Description
abstract Resource	SonarIndex.addResource(Resource resource) Deprecated. since 2.6. Use methods index()
Resource	CpdMapping.createResource(File file, List<File> sourceDirs) Deprecated. since 4.2 not used anymore
Resource	AbstractCpdMapping.createResource(File file, List<File> sourceDirs)
protected Resource	AbstractSourceImporter.createResource(File file, List<File> sourceDirs, boolean unitTest) Deprecated.
Resource	SensorContext.getParent(Resource reference)
abstract Resource	SonarIndex.getParent(Resource reference) Deprecated.
Resource	DefaultFormulaContext.getResource() Deprecated.
Resource	DecoratorContext.getResource()
Resource	SensorContext.getResource(InputPath inputPath) Allow to get Resource corresponding to provided InputPath.

Methods in org.sonar.api.batch that return types with arguments of type Resource

Modifier and Type	Method and Description
Collection<Resource>	SensorContext.getChildren(Resource reference)
abstract Collection<Resource>	SonarIndex.getChildren(Resource reference) Deprecated.
abstract Collection<Resource>	SonarIndex.getResources() Deprecated.

Methods in org.sonar.api.batch with parameters of type Resource

Modifier and Type	Method and Description
abstract Measure	SonarIndex.addMeasure(Resource resource, Measure measure) Deprecated. Warning: the resource is automatically indexed for backward-compatibility, but it should be explictly indexed before.
abstract Resource	SonarIndex.addResource(Resource resource) Deprecated. since 2.6. Use methods index()
void	Decorator.decorate(Resource resource, DecoratorContext context) Deprecated.
void	AbstractSumChildrenDecorator.decorate(Resource resource, DecoratorContext context) Deprecated.
Collection<Resource>	SensorContext.getChildren(Resource reference)
abstract Collection<Resource>	SonarIndex.getChildren(Resource reference) Deprecated.
abstract Measure	SonarIndex.getMeasure(Resource resource, Metric<?> metric) Deprecated.
<G extends Serializable> Measure<G>	SensorContext.getMeasure(Resource resource, Metric<G> metric) Deprecated. since 5.1 Sensors should not read but only save data
<M> M	SensorContext.getMeasures(Resource resource, MeasuresFilter<M> filter) Deprecated. since 5.1 Sensors should not read but only save data
abstract <M> M	SonarIndex.getMeasures(Resource resource, MeasuresFilter<M> filter) Deprecated.
Resource	SensorContext.getParent(Resource reference)
abstract Resource	SonarIndex.getParent(Resource reference) Deprecated.
abstract String	SonarIndex.getSource(Resource resource) Deprecated. since 5.0 sources are no more stored in SQ as a single blob. Use InputFile.file() to read file content from disk.
boolean	SensorContext.index(Resource resource) Deprecated. since 4.2 Resource indexing is done by the platform for all physical resources.
abstract boolean	SonarIndex.index(Resource resource) Deprecated. Indexes a resource as a direct child of project.
boolean	SensorContext.index(Resource resource, Resource parentReference) Deprecated. since 4.2 Resource indexing is done by the platform for all physical resources.
abstract boolean	SonarIndex.index(Resource resource, Resource parentReference) Deprecated. Indexes a resource.
boolean	SensorContext.isExcluded(Resource reference) Deprecated. since 4.2 Excluded resources are not indexed.
abstract boolean	SonarIndex.isExcluded(Resource reference) Deprecated. Returns true if the referenced resource is excluded.
boolean	ResourceFilter.isIgnored(Resource resource) Deprecated. Return true if the resource must be ignored, else it's saved into database.
boolean	SensorContext.isIndexed(Resource reference, boolean acceptExcluded) Deprecated. since 4.2 Excluded resources are not indexed.
abstract boolean	SonarIndex.isIndexed(Resource reference, boolean acceptExcluded) Deprecated.
Measure	SensorContext.saveMeasure(Resource resource, Measure measure) Add or update a measure.
Measure	SensorContext.saveMeasure(Resource resource, Metric metric, Double value) Add or update a measure.
String	SensorContext.saveResource(Resource resource) Deprecated. use the methods index()
void	SensorContext.saveSource(Resource reference, String source) Deprecated. since 4.2 Source import is done by the platform
boolean	AbstractSumChildrenDecorator.shouldDecorateResource(Resource resource) Deprecated.

Uses of Resource in org.sonar.api.component

Methods in org.sonar.api.component with parameters of type Resource

Modifier and Type	Method and Description
<P extends Perspective> P	ResourcePerspectives.as(Class<P> perspectiveClass, Resource resource)

Uses of Resource in org.sonar.api.design

Methods in org.sonar.api.design that return Resource

Modifier and Type	Method and Description
Resource	Dependency.getFrom() Deprecated.
Resource	Dependency.getTo() Deprecated.

Methods in org.sonar.api.design with parameters of type Resource

Modifier and Type	Method and Description
void	Dependency.setFrom(Resource from) Deprecated. For internal use only
void	Dependency.setTo(Resource to) Deprecated. For internal use only

Constructors in org.sonar.api.design with parameters of type Resource

Constructor and Description
Dependency(Resource from, Resource to) Deprecated.

Uses of Resource in org.sonar.api.measures

Methods in org.sonar.api.measures that return Resource

Modifier and Type	Method and Description
Resource	FormulaContext.getResource() Deprecated.

Methods in org.sonar.api.measures with parameters of type Resource

Modifier and Type	Method and Description
FileLinesContext	FileLinesContextFactory.createFor(Resource resource) Deprecated. since 4.4 use FileLinesContextFactory.createFor(InputFile)

Uses of Resource in org.sonar.api.resources

Subclasses of Resource in org.sonar.api.resources

Modifier and Type	Class and Description
class	Directory
class	File This class is an implementation of a resource of type FILE
class	JavaFile Deprecated. since 4.2 use File. See http://docs.codehaus.org/display/SONAR/API+Changes for more details
class	JavaPackage Deprecated. since 4.2 use Directory instead
class	Library Deprecated. since 5.2 No more design features
class	Method Deprecated. in 4.2. Only file system components are managed by SQ core (files/directories).
class	Project A class that manipulates Projects in the Sonar way.

Methods in org.sonar.api.resources that return Resource

Modifier and Type	Method and Description
Resource	Library.getParent() Deprecated.
Resource	Method.getParent() Deprecated.
Resource	JavaPackage.getParent() Deprecated.
abstract Resource	Resource.getParent() The parent is used to build the resources tree, for example for relations between files, directories and projects.
Resource	Directory.getParent()
Resource	Resource.setEffectiveKey(String effectiveKey) Internal use only
Resource	Resource.setExcluded(boolean b) Deprecated. since 2.6 should use SensorContext#isExcluded(resource). It will make inheritance of Resource easier.
Resource	Resource.setId(Integer id) Internal use only
Resource	Resource.setPath(String path)

Methods in org.sonar.api.resources with parameters of type Resource

Modifier and Type	Method and Description
static boolean	Scopes.isBlockUnit(Resource resource) Deprecated. since 4.3 resources under FILE level are no more be supported since 4.2.
static boolean	Qualifiers.isClass(Resource resource) Deprecated. since 4.2 CLA qualifier is deprecated
static boolean	ResourceUtils.isClass(Resource resource) Deprecated. since 4.2 CLA qualifier is deprecated
static boolean	Scopes.isDirectory(Resource resource)
static boolean	Qualifiers.isDirectory(Resource resource)
static boolean	ResourceUtils.isDirectory(Resource resource) Alias for ResourceUtils.isSpace(Resource)
static boolean	ResourceUtils.isEntity(Resource resource)
static boolean	Scopes.isFile(Resource resource) This scope is sometimes called a "compilation unit".
static boolean	Qualifiers.isFile(Resource resource)
static boolean	ResourceUtils.isFile(Resource resource) Alias for ResourceUtils.isEntity(Resource)
static boolean	Scopes.isHigherThan(Resource resource, String than)
static boolean	Scopes.isHigherThanOrEquals(Resource resource, String than)
static boolean	ResourceUtils.isLibrary(Resource resource) Deprecated. since 5.2 No more design features
static boolean	Qualifiers.isMethod(Resource resource)
static boolean	Qualifiers.isModule(Resource resource)
static boolean	ResourceUtils.isModuleProject(Resource resource)
static boolean	Qualifiers.isPackage(Resource resource) Deprecated. since 4.2 Package is now a directory. Use Qualifiers.isDirectory(Resource)
static boolean	ResourceUtils.isPackage(Resource resource) Deprecated. since 4.2 Package are now directory. Use ResourceUtils.isDirectory(Resource)
static boolean	Qualifiers.isParagraph(Resource resource)
static boolean	ResourceUtils.isPersistable(Resource resource)
static boolean	Scopes.isProgramUnit(Resource resource) Deprecated. since 4.3 resources under FILE level are no more be supported since 4.2.
static boolean	Scopes.isProject(Resource resource)
static boolean	ResourceUtils.isProject(Resource resource) This method equal isRootProject(resource) or isModuleProject(resource) or isView(resource) or isSubview(resource)
static boolean	Qualifiers.isProject(Resource resource, boolean acceptModules)
static boolean	ResourceUtils.isRootProject(Resource resource)
static boolean	ResourceUtils.isSet(Resource resource)
static boolean	ResourceUtils.isSpace(Resource resource)
static boolean	Qualifiers.isSubview(Resource resource)
static boolean	ResourceUtils.isSubview(Resource resource)
static boolean	ResourceUtils.isUnitTestClass(Resource resource) Deprecated. since 5.1 use ResourceUtils.isUnitTestFile(Resource)
static boolean	ResourceUtils.isUnitTestFile(Resource resource)
static boolean	ResourceUtils.isView(Resource resource)
static boolean	Qualifiers.isView(Resource resource, boolean acceptSubViews)

Constructors in org.sonar.api.resources with parameters of type Resource

Constructor and Description
DuplicatedSourceException(Resource resource)

Uses of Resource in org.sonar.api.security

Methods in org.sonar.api.security with parameters of type Resource

Modifier and Type	Method and Description
void	ResourcePermissions.grantDefaultRoles(Resource resource) Limitation - the resource id is used instead of logical key.
void	ResourcePermissions.grantGroupRole(Resource resource, String groupName, String role) Limitation - the resource id is used instead of logical key.
void	ResourcePermissions.grantUserRole(Resource resource, String login, String role) Limitation - the resource id is used instead of logical key.
boolean	ResourcePermissions.hasRoles(Resource resource) Limitation - the resource id is used instead of logical key.