org.sonar.wsclient.services
Class ResourceQuery

java.lang.Object
  org.sonar.wsclient.services.AbstractQuery<MODEL>
      org.sonar.wsclient.services.Query<Resource>
          org.sonar.wsclient.services.ResourceQuery

public class ResourceQuery
extends Query<Resource>

Field Summary

static String	BASE_URL
static int	DEPTH_UNLIMITED

Constructor Summary

ResourceQuery()

ResourceQuery(long resourceId)

ResourceQuery(String resourceKeyOrId)

Method Summary

static ResourceQuery	createForMetrics(String resourceKeyOrId, String... metricKeys)
static ResourceQuery	createForResource(Resource resource, String... metricKeys)
Integer	getDepth()
Integer	getLimit()
String[]	getMetrics()
Class<Resource>	getModelClass()
String[]	getQualifiers()
String	getResourceKeyOrId()
String[]	getRuleCategories()
String[]	getRulePriorities()
String[]	getRules()
String[]	getScopes()
String	getUrl() Must start with a slash, for example: /api/metrics
boolean	isExcludeRuleCategories()
boolean	isExcludeRulePriorities()
boolean	isExcludeRules()
Boolean	isIncludeTrends()
Boolean	isVerbose()
ResourceQuery	setAllDepths()
ResourceQuery	setCharacteristicKeys(String model, String... keys)
ResourceQuery	setDepth(Integer depth)
ResourceQuery	setExcludeRuleCategories(boolean excludeRuleCategories)
ResourceQuery	setExcludeRulePriorities(boolean excludeRulePriorities)
ResourceQuery	setExcludeRules(boolean excludeRules)
ResourceQuery	setIncludeTrends(Boolean includeTrends)
ResourceQuery	setLimit(Integer limit)
ResourceQuery	setMetrics(String... metrics)
ResourceQuery	setQualifiers(String... qualifiers)
ResourceQuery	setResourceId(int resourceId)
ResourceQuery	setResourceKeyOrId(String resourceKeyOrId)
ResourceQuery	setRuleCategories(String... ruleCategories)
ResourceQuery	setRulePriorities(String... rulePriorities)
ResourceQuery	setRules(String... rules)
ResourceQuery	setScopes(String... scopes)
ResourceQuery	setVerbose(Boolean verbose)

Methods inherited from class org.sonar.wsclient.services.AbstractQuery

appendUrlParameter, appendUrlParameter, appendUrlParameter

Methods inherited from class java.lang.Object

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

Field Detail

BASE_URL

public static final String BASE_URL

See Also:

Constant Field Values

DEPTH_UNLIMITED

public static final int DEPTH_UNLIMITED

See Also:

Constant Field Values

Constructor Detail

ResourceQuery

public ResourceQuery()

ResourceQuery

public ResourceQuery(String resourceKeyOrId)

ResourceQuery

public ResourceQuery(long resourceId)

Method Detail

getDepth

public Integer getDepth()

setDepth

public ResourceQuery setDepth(Integer depth)

setAllDepths

public ResourceQuery setAllDepths()

getResourceKeyOrId

public String getResourceKeyOrId()

setResourceKeyOrId

public ResourceQuery setResourceKeyOrId(String resourceKeyOrId)

setResourceId

public ResourceQuery setResourceId(int resourceId)

setCharacteristicKeys

public ResourceQuery setCharacteristicKeys(String model,
                                           String... keys)

getLimit

public Integer getLimit()

setLimit

public ResourceQuery setLimit(Integer limit)

getScopes

public String[] getScopes()

setScopes

public ResourceQuery setScopes(String... scopes)

getQualifiers

public String[] getQualifiers()

setQualifiers

public ResourceQuery setQualifiers(String... qualifiers)

getMetrics

public String[] getMetrics()

setMetrics

public ResourceQuery setMetrics(String... metrics)

getRules

public String[] getRules()

setRules

public ResourceQuery setRules(String... rules)

getRuleCategories

public String[] getRuleCategories()

setRuleCategories

public ResourceQuery setRuleCategories(String... ruleCategories)

Parameters:

ruleCategories - values: Maintainability, Usability, Reliability, Efficiency, Portability

getRulePriorities

public String[] getRulePriorities()

setRulePriorities

public ResourceQuery setRulePriorities(String... rulePriorities)

Parameters:

rulePriorities - values: BLOCKER, CRITICAL, MAJOR, MINOR, INFO

isExcludeRules

public boolean isExcludeRules()

setExcludeRules

public ResourceQuery setExcludeRules(boolean excludeRules)

isExcludeRuleCategories

public boolean isExcludeRuleCategories()

setExcludeRuleCategories

public ResourceQuery setExcludeRuleCategories(boolean excludeRuleCategories)

isExcludeRulePriorities

public boolean isExcludeRulePriorities()

setExcludeRulePriorities

public ResourceQuery setExcludeRulePriorities(boolean excludeRulePriorities)

isVerbose

public Boolean isVerbose()

setVerbose

public ResourceQuery setVerbose(Boolean verbose)

isIncludeTrends

public Boolean isIncludeTrends()

setIncludeTrends

public ResourceQuery setIncludeTrends(Boolean includeTrends)

getUrl

public String getUrl()

Description copied from class: AbstractQuery

Must start with a slash, for example: /api/metrics

Specified by:

getUrl in class AbstractQuery<Resource>

getModelClass

public final Class<Resource> getModelClass()

Specified by:

getModelClass in class Query<Resource>

createForMetrics

public static ResourceQuery createForMetrics(String resourceKeyOrId,
                                             String... metricKeys)

createForResource

public static ResourceQuery createForResource(Resource resource,
                                              String... metricKeys)