org.sonar.wsclient.services
Class ResourceQuery

java.lang.Object
  extended by org.sonar.wsclient.services.AbstractQuery<M>
      extended by org.sonar.wsclient.services.Query<Resource>
          extended by org.sonar.wsclient.services.ResourceQuery

public class ResourceQuery
extends Query<Resource>


Field Summary
static String BASE_URL
           
static int DEPTH_UNLIMITED
           
 
Fields inherited from class org.sonar.wsclient.services.AbstractQuery
DEFAULT_TIMEOUT_MILLISECONDS
 
Constructor Summary
ResourceQuery()
           
ResourceQuery(long resourceId)
           
ResourceQuery(String resourceKeyOrId)
           
 
Method Summary
static ResourceQuery create(String resourceKey)
           
static ResourceQuery createForMetrics(String resourceKeyOrId, String... metricKeys)
           
static ResourceQuery createForResource(Resource resource, String... metricKeys)
           
 Integer getDepth()
           
 String[] getLanguages()
           
 Integer getLimit()
           
 String[] getMetrics()
           
 Class<Resource> getModelClass()
           
 String[] getQualifiers()
           
 String getResourceKeyOrId()
           
 String[] getRuleCategories()
          Deprecated. since 2.5 See http://jira.codehaus.org/browse/SONAR-2007
 String[] getRulePriorities()
          Deprecated. since 2.5 use getRuleSeverities() instead. See http://jira.codehaus.org/browse/SONAR-1829
 String[] getRules()
           
 String[] getRuleSeverities()
           
 String[] getScopes()
           
 String getUrl()
          Must start with a slash, for example: /api/metrics
 boolean isExcludeRuleCategories()
          Deprecated. since 2.5 not used anymore
 boolean isExcludeRulePriorities()
          Deprecated. since 2.5 use isExcludeRuleSeverities() instead. See http://jira.codehaus.org/browse/SONAR-1829
 boolean isExcludeRules()
           
 boolean isExcludeRuleSeverities()
           
 Boolean isIncludeTrends()
           
 Boolean isVerbose()
           
 ResourceQuery setAllDepths()
           
 ResourceQuery setCharacteristics(String... keys)
           
 ResourceQuery setDepth(Integer depth)
           
 ResourceQuery setExcludeRuleCategories(boolean b)
          Deprecated. since 2.5 not used anymore
 ResourceQuery setExcludeRulePriorities(boolean b)
          Deprecated. since 2.5 use setExcludeRuleSeverities(boolean) instead. See http://jira.codehaus.org/browse/SONAR-1829
 ResourceQuery setExcludeRules(boolean excludeRules)
           
 ResourceQuery setExcludeRuleSeverities(boolean excludeRuleSeverities)
           
 ResourceQuery setIncludeTrends(Boolean includeTrends)
           
 ResourceQuery setLanguages(String... languages)
           
 ResourceQuery setLimit(Integer limit)
           
 ResourceQuery setMetrics(String... metrics)
           
 ResourceQuery setQualifiers(String... qualifiers)
           
 ResourceQuery setResourceId(int resourceId)
           
 ResourceQuery setResourceKeyOrId(String resourceKeyOrId)
           
 ResourceQuery setRuleCategories(String... ruleCategories)
          Deprecated. since 2.5 See http://jira.codehaus.org/browse/SONAR-2007
 ResourceQuery setRulePriorities(String... rulePriorities)
          Deprecated. since 2.5 use setRuleSeverities(String...) instead. See http://jira.codehaus.org/browse/SONAR-1829
 ResourceQuery setRules(String... rules)
           
 ResourceQuery setRuleSeverities(String... ruleSeverities)
           
 ResourceQuery setScopes(String... scopes)
           
 ResourceQuery setVerbose(Boolean verbose)
           
 
Methods inherited from class org.sonar.wsclient.services.AbstractQuery
appendUrlParameter, appendUrlParameter, appendUrlParameter, appendUrlParameter, encode, getBody, getLocale, getTimeoutMilliseconds, setLocale, setTimeoutMilliseconds
 
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)

setCharacteristics

public ResourceQuery setCharacteristics(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)

getLanguages

public String[] getLanguages()

setLanguages

public ResourceQuery setLanguages(String... languages)

getRuleCategories

@Deprecated
public String[] getRuleCategories()
Deprecated. since 2.5 See http://jira.codehaus.org/browse/SONAR-2007


setRuleCategories

@Deprecated
public ResourceQuery setRuleCategories(String... ruleCategories)
Deprecated. since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

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

getRuleSeverities

public String[] getRuleSeverities()
Since:
2.5

setRuleSeverities

public ResourceQuery setRuleSeverities(String... ruleSeverities)
Parameters:
ruleSeverities - values: BLOCKER, CRITICAL, MAJOR, MINOR, INFO
Since:
2.5

getRulePriorities

@Deprecated
public String[] getRulePriorities()
Deprecated. since 2.5 use getRuleSeverities() instead. See http://jira.codehaus.org/browse/SONAR-1829


setRulePriorities

@Deprecated
public ResourceQuery setRulePriorities(String... rulePriorities)
Deprecated. since 2.5 use setRuleSeverities(String...) instead. See http://jira.codehaus.org/browse/SONAR-1829


isExcludeRules

public boolean isExcludeRules()

setExcludeRules

public ResourceQuery setExcludeRules(boolean excludeRules)

isExcludeRuleCategories

@Deprecated
public boolean isExcludeRuleCategories()
Deprecated. since 2.5 not used anymore


setExcludeRuleCategories

@Deprecated
public ResourceQuery setExcludeRuleCategories(boolean b)
Deprecated. since 2.5 not used anymore


isExcludeRuleSeverities

public boolean isExcludeRuleSeverities()
Since:
2.5

setExcludeRuleSeverities

public ResourceQuery setExcludeRuleSeverities(boolean excludeRuleSeverities)

isExcludeRulePriorities

@Deprecated
public boolean isExcludeRulePriorities()
Deprecated. since 2.5 use isExcludeRuleSeverities() instead. See http://jira.codehaus.org/browse/SONAR-1829


setExcludeRulePriorities

@Deprecated
public ResourceQuery setExcludeRulePriorities(boolean b)
Deprecated. since 2.5 use setExcludeRuleSeverities(boolean) instead. See http://jira.codehaus.org/browse/SONAR-1829


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

IMPORTANT: In implementations of this method we must use helper methods to construct URL.

Specified by:
getUrl in class AbstractQuery<Resource>
See Also:
AbstractQuery.encode(String), AbstractQuery.appendUrlParameter(StringBuilder, String, Object), AbstractQuery.appendUrlParameter(StringBuilder, String, Object[]), AbstractQuery.appendUrlParameter(StringBuilder, String, Date, boolean)

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)

create

public static ResourceQuery create(String resourceKey)
Since:
2.10


Copyright © 2009-2014 SonarSource. All Rights Reserved.