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

Packages that use Resource

Package	Description
org.sonar.api.batch
org.sonar.api.checks
org.sonar.api.database.model
org.sonar.api.design
org.sonar.api.measures
org.sonar.api.resources
org.sonar.api.rules
org.sonar.api.security
org.sonar.api.violations

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
abstract <R extends Resource> R	SonarIndex.getResource(R reference) Search for an indexed resource.
<R extends Resource> R	SensorContext.getResource(R reference) 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)
Resource	AbstractCpdMapping.createResource(File file, List<File> sourceDirs)
protected Resource	AbstractSourceImporter.createResource(File file, List<File> sourceDirs, boolean unitTest)
abstract Resource	SonarIndex.getParent(Resource reference)
Resource	SensorContext.getParent(Resource reference)
Resource	TimeMachineQuery.getResource()
Resource	DefaultFormulaContext.getResource()
Resource	DecoratorContext.getResource()

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

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

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

Modifier and Type	Method and Description
abstract Event	SonarIndex.addEvent(Resource resource, String name, String description, String category, Date date)
abstract Measure	SonarIndex.addMeasure(Resource resource, Measure measure) 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()
Event	SensorContext.createEvent(Resource resource, String name, String description, String category, Date date) Creates an event for a given date
void	Decorator.decorate(Resource resource, DecoratorContext context)
void	AbstractSumChildrenDecorator.decorate(Resource resource, DecoratorContext context)
void	AbstractFunctionComplexityDistributionDecorator.decorate(Resource resource, DecoratorContext context) Deprecated.
void	AbstractFunctionComplexityDecorator.decorate(Resource resource, DecoratorContext context) Deprecated.
void	AbstractFilesDecorator.decorate(Resource resource, DecoratorContext context) Deprecated.
void	AbstractFileComplexityDecorator.decorate(Resource resource, DecoratorContext context) Deprecated.
void	AbstractDivisionDecorator.decorate(Resource resource, DecoratorContext context)
void	AbstractDirectoriesDecorator.decorate(Resource resource, DecoratorContext context) Deprecated.
abstract Collection<Resource>	SonarIndex.getChildren(Resource reference)
Collection<Resource>	SensorContext.getChildren(Resource reference)
abstract List<Event>	SonarIndex.getEvents(Resource resource)
List<Event>	SensorContext.getEvents(Resource resource)
Collection<Dependency>	SonarIndex.getIncomingDependencies(Resource to)
Collection<Dependency>	SensorContext.getIncomingDependencies(Resource to)
abstract Measure	SonarIndex.getMeasure(Resource resource, Metric metric)
Measure	SensorContext.getMeasure(Resource resource, Metric metric) Find a measure for this project
abstract <M> M	SonarIndex.getMeasures(Resource resource, MeasuresFilter<M> filter)
<M> M	SensorContext.getMeasures(Resource resource, MeasuresFilter<M> filter) Find all measures for this project.
Collection<Dependency>	SonarIndex.getOutgoingDependencies(Resource from)
Collection<Dependency>	SensorContext.getOutgoingDependencies(Resource from)
abstract Resource	SonarIndex.getParent(Resource reference)
Resource	SensorContext.getParent(Resource reference)
abstract String	SonarIndex.getSource(Resource resource)
List<Violation>	SonarIndex.getViolations(Resource resource) Returns all the active (= non switched-off) violations found on the given resource.
abstract boolean	SonarIndex.index(Resource resource) Indexes a resource as a direct child of project.
boolean	SensorContext.index(Resource resource) Indexes a resource as a direct child of project.
abstract boolean	SonarIndex.index(Resource resource, Resource parentReference) Indexes a resource.
abstract boolean	SonarIndex.index(Resource resource, Resource parentReference) Indexes a resource.
boolean	SensorContext.index(Resource resource, Resource parentReference) Indexes a resource.
boolean	SensorContext.index(Resource resource, Resource parentReference) Indexes a resource.
abstract boolean	SonarIndex.isExcluded(Resource reference) Returns true if the referenced resource is excluded.
boolean	SensorContext.isExcluded(Resource reference) Returns true if the referenced resource is indexed and excluded.
boolean	ResourceFilter.isIgnored(Resource resource) Return true if the resource must be ignored, else it's saved into database.
abstract boolean	SonarIndex.isIndexed(Resource reference, boolean acceptExcluded)
boolean	SensorContext.isIndexed(Resource reference, boolean acceptExcluded) Returns true if the referenced resource is indexed.
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) Save the source code of a file.
TimeMachineQuery	TimeMachineQuery.setResource(Resource resource) Sets the resource of the query
abstract void	SonarIndex.setSource(Resource reference, String source) Save the source code of a file.
boolean	AbstractSumChildrenDecorator.shouldDecorateResource(Resource resource)

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

Constructor and Description
TimeMachineQuery(Resource resource) Create a TimeMachine query for a given resource

Uses of Resource in org.sonar.api.checks

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

Modifier and Type	Method and Description
void	NoSonarFilter.addResource(Resource resource, Set<Integer> noSonarLines)

Uses of Resource in org.sonar.api.database.model

Methods in org.sonar.api.database.model with parameters of type Resource

Modifier and Type	Method and Description
static ResourceModel	ResourceModel.build(Resource resource) Maps a resource to a resource model and returns the 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()
Resource	Dependency.getTo()

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

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

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()

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

Modifier and Type	Method and Description
FileLinesContext	FileLinesContextFactory.createFor(Resource resource)

Uses of Resource in org.sonar.api.resources

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

Modifier and Type	Class and Description
class	Resource<P extends Resource> The interface to implement to create a resource in Sonar

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 A class that represents a Java class.
class	JavaPackage A class that represents a Java package in Sonar
class	Library
class	Method
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	Method.getParent()
Resource	Library.getParent()
Resource<?>	JavaPackage.getParent() The parent is used to build the resources tree, for example for relations between classes, packages 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	ProjectFileSystem.toResource(File file)
Resource	DefaultProjectFileSystem.toResource(File file) Deprecated.

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

Modifier and Type	Method and Description
static boolean	Scopes.isBlockUnit(Resource resource)
static boolean	ResourceUtils.isClass(Resource resource)
static boolean	Qualifiers.isClass(Resource resource)
static boolean	Scopes.isDirectory(Resource resource)
static boolean	ResourceUtils.isDirectory(Resource resource) Alias for ResourceUtils.isSpace(Resource)
static boolean	Qualifiers.isDirectory(Resource resource)
static boolean	ResourceUtils.isEntity(Resource resource)
static boolean	Scopes.isFile(Resource resource) This scope is sometimes called a "compilation unit".
static boolean	ResourceUtils.isFile(Resource resource) Alias for ResourceUtils.isEntity(Resource)
static boolean	Qualifiers.isFile(Resource resource)
static boolean	Scopes.isHigherThan(Resource resource, String than)
static boolean	Scopes.isHigherThanOrEquals(Resource resource, String than)
static boolean	ResourceUtils.isLibrary(Resource resource)
static boolean	Qualifiers.isMethod(Resource resource)
static boolean	Qualifiers.isModule(Resource resource)
static boolean	ResourceUtils.isModuleProject(Resource resource)
static boolean	ResourceUtils.isPackage(Resource resource)
static boolean	Qualifiers.isPackage(Resource resource)
static boolean	Qualifiers.isParagraph(Resource resource)
static boolean	ResourceUtils.isPersistable(Resource resource)
static boolean	Scopes.isProgramUnit(Resource resource) A program unit can be a Java class.
static boolean	Scopes.isProject(Resource resource)
static boolean	ResourceUtils.isProject(Resource resource) This method equal isRootProject(resource) or isModuleProject(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	ResourceUtils.isSubview(Resource resource)
static boolean	Qualifiers.isSubview(Resource resource)
static boolean	ResourceUtils.isUnitTestClass(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.rules

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

Modifier and Type	Method and Description
Resource	Violation.getResource()

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

Modifier and Type	Method and Description
static Violation	Violation.create(ActiveRule activeRule, Resource resource)
static Violation	Violation.create(Rule rule, Resource resource)
Violation	Violation.setResource(Resource resource) Sets the resource the violation applies to

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

Constructor and Description
Violation(Rule rule, Resource resource) Deprecated. since 2.3. Use the factory method create()

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.

Uses of Resource in org.sonar.api.violations

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

Modifier and Type	Method and Description
Resource	ViolationQuery.getResource() Returns the resource which violations are search from.

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

Modifier and Type	Method and Description
ViolationQuery	ViolationQuery.forResource(Resource resource) Specifies the resource which violations are search from.