org.sonar.api.violations
Class ViolationQuery

java.lang.Object
  org.sonar.api.violations.ViolationQuery

public final class ViolationQuery
extends Object

Class that allows to query the Sonar index about violations.

Since:

2.8

Method Summary

static ViolationQuery	create() Creates a new ViolationQuery object.
ViolationQuery	forResource(Resource resource) Specifies the resource which violations are search from.
Resource	getResource() Returns the resource which violations are search from.
boolean	isSwitchedOff() Tells if the query should returned switched-off violations or active violations.
ViolationQuery	setSwitchedOff(boolean ignore) Specifies if the query should returned switched-off violations or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static ViolationQuery create()

Creates a new ViolationQuery object.

Returns:

the new query

setSwitchedOff

public ViolationQuery setSwitchedOff(boolean ignore)

Specifies if the query should returned switched-off violations or not.

Parameters:

ignore - if true, the query will return only switched-off violations. if false, it will return only active violations.

Returns:

the current violation query

isSwitchedOff

public boolean isSwitchedOff()

Tells if the query should returned switched-off violations or active violations.

Returns:

forResource

public ViolationQuery forResource(Resource resource)

Specifies the resource which violations are search from.

Parameters:

resource - the resource

getResource

public Resource getResource()

Returns the resource which violations are search from.

Returns:

the resource