org.sonar.wsclient.services
Class DependencyQuery

java.lang.Object
  extended by org.sonar.wsclient.services.AbstractQuery<M>
      extended by org.sonar.wsclient.services.Query<Dependency>
          extended by org.sonar.wsclient.services.DependencyQuery

public class DependencyQuery
extends Query<Dependency>

The web service "dependency" is since Sonar 2.0


Field Summary
static String BASE_URL
           
static String INCOMING_DIRECTION
           
static String OUTGOING_DIRECTION
           
 
Fields inherited from class org.sonar.wsclient.services.AbstractQuery
DEFAULT_TIMEOUT_MILLISECONDS
 
Constructor Summary
DependencyQuery()
           
 
Method Summary
static DependencyQuery createForId(String id)
           
static DependencyQuery createForIncomingDependencies(String resourceIdOrKey)
          Resources that depend upon a resource
static DependencyQuery createForOutgoingDependencies(String resourceIdOrKey)
          Resources that are depended upon a resource = all the resources that a resource depends upon
static DependencyQuery createForResource(long resourceId)
           
static DependencyQuery createForResource(String resourceIdOrKey)
          Resources that depend upon or are depended upon a resource.
static DependencyQuery createForSubDependencies(String dependencyId)
           
 String getDirection()
           
 String getId()
           
 Class<Dependency> getModelClass()
           
 String getParentId()
           
 String getResourceIdOrKey()
           
 String getUrl()
          Must start with a slash, for example: /api/metrics
 DependencyQuery setDirection(String direction)
           
 DependencyQuery setId(String id)
           
 DependencyQuery setParentId(String parentId)
           
 DependencyQuery setResourceId(long resourceId)
           
 DependencyQuery setResourceIdOrKey(String resourceIdOrKey)
           
 
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

INCOMING_DIRECTION

public static final String INCOMING_DIRECTION
See Also:
Constant Field Values

OUTGOING_DIRECTION

public static final String OUTGOING_DIRECTION
See Also:
Constant Field Values
Constructor Detail

DependencyQuery

public DependencyQuery()
Method Detail

getResourceIdOrKey

public String getResourceIdOrKey()

setResourceIdOrKey

public DependencyQuery setResourceIdOrKey(String resourceIdOrKey)

setResourceId

public DependencyQuery setResourceId(long resourceId)

getDirection

public String getDirection()

setDirection

public DependencyQuery setDirection(String direction)

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<Dependency>
See Also:
AbstractQuery.encode(String), AbstractQuery.appendUrlParameter(StringBuilder, String, Object), AbstractQuery.appendUrlParameter(StringBuilder, String, Object[]), AbstractQuery.appendUrlParameter(StringBuilder, String, Date, boolean)

getParentId

public String getParentId()

getId

public String getId()

setId

public DependencyQuery setId(String id)

setParentId

public DependencyQuery setParentId(String parentId)

getModelClass

public Class<Dependency> getModelClass()
Specified by:
getModelClass in class Query<Dependency>

createForIncomingDependencies

public static DependencyQuery createForIncomingDependencies(String resourceIdOrKey)
Resources that depend upon a resource

Parameters:
resourceIdOrKey - the target resource. Can be the primary key (a number) or the logical key (String)

createForOutgoingDependencies

public static DependencyQuery createForOutgoingDependencies(String resourceIdOrKey)
Resources that are depended upon a resource = all the resources that a resource depends upon

Parameters:
resourceIdOrKey - the target resource. Can be the primary key (an integer) or the logical key (String)

createForResource

public static DependencyQuery createForResource(String resourceIdOrKey)
Resources that depend upon or are depended upon a resource. It equals the merge of createForIncomingDependencies(resourceIdOrKey) and createForOutgoingDependencies(resourceIdOrKey)

Parameters:
resourceIdOrKey - the target resource. Can be the primary key (an integer) or the logical key (String)

createForResource

public static DependencyQuery createForResource(long resourceId)

createForSubDependencies

public static DependencyQuery createForSubDependencies(String dependencyId)

createForId

public static DependencyQuery createForId(String id)


Copyright © 2009–2014 SonarSource. All rights reserved.