org.sonar.api.server.ws
Class WebService.Param

java.lang.Object
  extended by org.sonar.api.server.ws.WebService.Param
Enclosing interface:
WebService

@Immutable
public static class WebService.Param
extends Object


Constructor Summary
WebService.Param(WebService.NewParam newParam)
           
 
Method Summary
 String defaultValue()
           
 String description()
           
 String exampleValue()
           
 boolean isRequired()
          Is the parameter required or optional ?
 String key()
           
 Set<String> possibleValues()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WebService.Param

public WebService.Param(WebService.NewParam newParam)
Method Detail

key

public String key()

description

@CheckForNull
public String description()

exampleValue

@CheckForNull
public String exampleValue()
Since:
4.4

isRequired

public boolean isRequired()
Is the parameter required or optional ?

Since:
4.4

possibleValues

@CheckForNull
public Set<String> possibleValues()
Since:
4.4

defaultValue

@CheckForNull
public String defaultValue()
Since:
4.4

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2009–2016 SonarSource. All rights reserved.