org.springframework.xd.dirt.rest

Class CompletionsController

java.lang.Object

org.springframework.xd.dirt.rest.CompletionsController

@RestController
@RequestMapping(value="/completions")
@Lazy
public class CompletionsController
extends java.lang.Object

Exposes completion for stream-like definitions as a REST endpoint.

Author:

Eric Bottard

Constructor Summary

Constructors

Constructor and Description
CompletionsController(CompletionProvider completionProvider)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	completions(CompletionKind kind, java.lang.String start, int detailLevel) Return a list of possible completions given a prefix string that the user has started typing.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompletionsController

@Autowired
public CompletionsController(CompletionProvider completionProvider)

Method Detail

completions

@RequestMapping(value="/{kind}")
public java.util.List<java.lang.String> completions(@PathVariable(value="kind")
                                                          CompletionKind kind,
                                                          @RequestParam(value="start")
                                                          java.lang.String start,
                                                          @RequestParam(value="detailLevel",defaultValue="1")
                                                          int detailLevel)

Return a list of possible completions given a prefix string that the user has started typing.

Parameters:

kind - the kind of definition that is being authored

start - the amount of text written so far

detailLevel - the level of detail the user wants in completions (e.g. higher numbers may mean show 'hidden' options)