org.sonar.api.server.ws

Class WebService.Action

java.lang.Object

org.sonar.api.server.ws.WebService.Action

Enclosing interface:

WebService

@Immutable
public static class WebService.Action
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
java.util.List<Change>	changelog()
java.lang.String	deprecatedKey()
java.lang.String	deprecatedSince()
java.lang.String	description()
RequestHandler	handler()
boolean	isInternal()
boolean	isPost()
java.lang.String	key()
WebService.Param	param(java.lang.String key)
java.util.Collection<WebService.Param>	params()
java.lang.String	path()
java.net.URL	responseExample()
java.lang.String	responseExampleAsString()
java.lang.String	responseExampleFormat()
java.lang.String	since() Set if different than controller.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

key

public java.lang.String key()

deprecatedKey

public java.lang.String deprecatedKey()

path

public java.lang.String path()

description

@CheckForNull
public java.lang.String description()

since

@CheckForNull
public java.lang.String since()

Set if different than controller.

deprecatedSince

@CheckForNull
public java.lang.String deprecatedSince()

isPost

public boolean isPost()

changelog

public java.util.List<Change> changelog()

Since:

6.4

See Also:

WebService.NewAction.setChangelog(Change...)

isInternal

public boolean isInternal()

See Also:

WebService.NewAction.setInternal(boolean)

handler

public RequestHandler handler()

responseExample

@CheckForNull
public java.net.URL responseExample()

See Also:

WebService.NewAction.setResponseExample(java.net.URL)

responseExampleAsString

@CheckForNull
public java.lang.String responseExampleAsString()

See Also:

WebService.NewAction.setResponseExample(java.net.URL)

responseExampleFormat

@CheckForNull
public java.lang.String responseExampleFormat()

See Also:

WebService.NewAction.setResponseExample(java.net.URL)

param

@CheckForNull
public WebService.Param param(java.lang.String key)

params

public java.util.Collection<WebService.Param> params()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object