Module com.ensarsarajcic.neovim.java.neovimapi

Package com.ensarsarajcic.neovim.java.api.buffer

Interface NeovimBufferApi

All Known Implementing Classes:

BufferStreamApi

public interface NeovimBufferApi

Interface representing neovim methods of Buffer object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_HIGHLIGHT
static final String	ATTACH_BUFFER
static final String	CALL
static final String	CLEAR_HIGHLIGHT
static final String	CLEAR_NAMESPACE
static final String	CREATE_USER_COMMAND
static final String	DEL_EXTMARK
static final String	DEL_KEYMAP
static final String	DEL_MARK
static final String	DEL_USER_COMMAND
static final String	DEL_VAR
static final String	DELETE
static final String	DETACH_BUFFER
static final String	GET_CHANGEDTICK
static final String	GET_COMMANDS
static final String	GET_EXTMARK_BY_ID
static final String	GET_EXTMARKS
static final String	GET_KEYMAP
static final String	GET_LINE_COUNT
static final String	GET_LINES
static final String	GET_MARK
static final String	GET_NAME
static final String	GET_NUMBER
static final String	GET_OFFSET
static final String	GET_OPTION
static final String	GET_TEXT
static final String	GET_VAR
static final String	IS_LOADED
static final String	IS_VALID
static final String	SET_EXTMARK
static final String	SET_KEYMAP
static final String	SET_LINES
static final String	SET_MARK
static final String	SET_NAME
static final String	SET_OPTION
static final String	SET_TEXT
static final String	SET_VAR
static final String	SET_VIRTUAL_TEXT

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Integer>	addHighlight(int srcId, String hlGroup, int line, int colStart, int colEnd)
CompletableFuture<Boolean>	attach(boolean loadFullBufferOnStart, Map opts)
CompletableFuture<Object>	call(Object luaFun)
CompletableFuture<Void>	clearHighlight(int srcId, int lineStart, int lineEnd)
CompletableFuture<Void>	clearNamespace(int namespaceId, int lineStart, int lineEnd)
CompletableFuture<Void>	createUserCommand(String name, String command, Map<String,Object> options)
CompletableFuture<Void>	delete(DeleteBufferOptions options)
CompletableFuture<Boolean>	deleteExtmark(int nsId, int extmarkId)
CompletableFuture<Void>	deleteKeymap(String mode, String lhs)
CompletableFuture<Boolean>	deleteMark(String name)
CompletableFuture<Void>	deleteUserCommand(String name)
CompletableFuture<Void>	deleteVar(String name)
CompletableFuture<Boolean>	detach()
Buffer	get()
CompletableFuture<Object>	getChangedTick()
CompletableFuture<Map<String,CommandInfo>>	getCommands(GetCommandsOptions commandsOptions)
CompletableFuture<VimCoords>	getExtmarkById(int nsId, int extmarkId, GetBufferExtmarkOptions options)
CompletableFuture<List<ExtmarkInfo>>	getExtmarks(int nsId, VimCoords start, VimCoords end, GetBufferExtmarksOptions options)
CompletableFuture<List<VimKeyMap>>	getKeymap(String mode)
CompletableFuture<Integer>	getLineCount()
CompletableFuture<List<String>>	getLines(int start, int end, boolean strictIndexing)
CompletableFuture<VimCoords>	getMark(String name)
CompletableFuture<String>	getName()
CompletableFuture<Integer>	getNumber()	Deprecated.
CompletableFuture<Integer>	getOffset(int index)
CompletableFuture<Object>	getOption(String name)
CompletableFuture<List<String>>	getText(int startRow, int startCol, int endRow, int endCol, Map<String,Object> options)
CompletableFuture<Object>	getVar(String name)
CompletableFuture<Boolean>	isLoaded()
CompletableFuture<Boolean>	isValid()
CompletableFuture<Integer>	setExtmark(int nsId, int line, int col, Map<String,Object> options)
CompletableFuture<Void>	setKeymap(String mode, String lhs, String rhs, Map<String,Boolean> options)
CompletableFuture<Void>	setLines(int start, int end, boolean strictIndexing, List<String> replacement)
CompletableFuture<Boolean>	setMark(String name, int line, int col, Map<String,Object> options)
CompletableFuture<Void>	setName(String name)
CompletableFuture<Void>	setOption(String name, Object value)
CompletableFuture<Void>	setText(int startRow, int startCol, int endRow, int endCol, List<String> lines)
CompletableFuture<Void>	setVar(String name, Object value)
CompletableFuture<Integer>	setVirtualText(int namespaceId, int line, List<HighlightedText> chunks, Map optionalParams)

Field Details

GET_LINE_COUNT

static final String GET_LINE_COUNT

See Also:

• Constant Field Values

GET_LINES

static final String GET_LINES

See Also:

• Constant Field Values

SET_LINES

static final String SET_LINES

See Also:

• Constant Field Values

GET_OFFSET

static final String GET_OFFSET

See Also:

• Constant Field Values

GET_VAR

static final String GET_VAR

See Also:

• Constant Field Values

DEL_VAR

static final String DEL_VAR

See Also:

• Constant Field Values

SET_VAR

static final String SET_VAR

See Also:

• Constant Field Values

GET_OPTION

static final String GET_OPTION

See Also:

• Constant Field Values

SET_OPTION

static final String SET_OPTION

See Also:

• Constant Field Values

GET_NUMBER

static final String GET_NUMBER

See Also:

• Constant Field Values

GET_NAME

static final String GET_NAME

See Also:

• Constant Field Values

SET_NAME

static final String SET_NAME

See Also:

• Constant Field Values

IS_LOADED

static final String IS_LOADED

See Also:

• Constant Field Values

IS_VALID

static final String IS_VALID

See Also:

• Constant Field Values

GET_MARK

static final String GET_MARK

See Also:

• Constant Field Values

GET_CHANGEDTICK

static final String GET_CHANGEDTICK

See Also:

• Constant Field Values

GET_KEYMAP

static final String GET_KEYMAP

See Also:

• Constant Field Values

SET_KEYMAP

static final String SET_KEYMAP

See Also:

• Constant Field Values

DEL_KEYMAP

static final String DEL_KEYMAP

See Also:

• Constant Field Values

ADD_HIGHLIGHT

static final String ADD_HIGHLIGHT

See Also:

• Constant Field Values

CLEAR_HIGHLIGHT

static final String CLEAR_HIGHLIGHT

See Also:

• Constant Field Values

CLEAR_NAMESPACE

static final String CLEAR_NAMESPACE

See Also:

• Constant Field Values

SET_VIRTUAL_TEXT

static final String SET_VIRTUAL_TEXT

See Also:

• Constant Field Values

ATTACH_BUFFER

static final String ATTACH_BUFFER

See Also:

• Constant Field Values

DETACH_BUFFER

static final String DETACH_BUFFER

See Also:

• Constant Field Values

GET_COMMANDS

static final String GET_COMMANDS

See Also:

• Constant Field Values

SET_TEXT

static final String SET_TEXT

See Also:

• Constant Field Values

DELETE

static final String DELETE

See Also:

• Constant Field Values

CALL

static final String CALL

See Also:

• Constant Field Values

GET_EXTMARK_BY_ID

static final String GET_EXTMARK_BY_ID

See Also:

• Constant Field Values

GET_EXTMARKS

static final String GET_EXTMARKS

See Also:

• Constant Field Values

SET_EXTMARK

static final String SET_EXTMARK

See Also:

• Constant Field Values

DEL_EXTMARK

static final String DEL_EXTMARK

See Also:

• Constant Field Values

DEL_MARK

static final String DEL_MARK

See Also:

• Constant Field Values

SET_MARK

static final String SET_MARK

See Also:

• Constant Field Values

GET_TEXT

static final String GET_TEXT

See Also:

• Constant Field Values

CREATE_USER_COMMAND

static final String CREATE_USER_COMMAND

See Also:

• Constant Field Values

DEL_USER_COMMAND

static final String DEL_USER_COMMAND

See Also:

• Constant Field Values

Method Details

get

Buffer get()

getLineCount

@NeovimApiFunction(name="nvim_buf_line_count",
                   since=1)
CompletableFuture<Integer> getLineCount()

getLines

@NeovimApiFunction(name="nvim_buf_get_lines",
                   since=1)
CompletableFuture<List<String>> getLines(int start,
 int end,
 boolean strictIndexing)

setLines

@NeovimApiFunction(name="nvim_buf_set_lines",
                   since=1)
CompletableFuture<Void> setLines(int start,
 int end,
 boolean strictIndexing,
 List<String> replacement)

getOffset

@NeovimApiFunction(name="nvim_buf_get_offset",
                   since=5)
CompletableFuture<Integer> getOffset(int index)

getVar

@NeovimApiFunction(name="nvim_buf_get_var",
                   since=1)
CompletableFuture<Object> getVar(String name)

deleteVar

@NeovimApiFunction(name="nvim_buf_del_var",
                   since=1)
CompletableFuture<Void> deleteVar(String name)

setVar

@NeovimApiFunction(name="nvim_buf_set_var",
                   since=1)
CompletableFuture<Void> setVar(String name,
 Object value)

getOption

@NeovimApiFunction(name="nvim_buf_get_option",
                   since=1)
CompletableFuture<Object> getOption(String name)

setOption

@NeovimApiFunction(name="nvim_buf_set_option",
                   since=1)
CompletableFuture<Void> setOption(String name,
 Object value)

getNumber

@NeovimApiFunction(name="nvim_buf_get_number",
                   since=1,
                   deprecatedIn=2)
@Deprecated
CompletableFuture<Integer> getNumber()

Deprecated.

getName

@NeovimApiFunction(name="nvim_buf_get_name",
                   since=1)
CompletableFuture<String> getName()

setName

@NeovimApiFunction(name="nvim_buf_set_name",
                   since=1)
CompletableFuture<Void> setName(String name)

isLoaded

@NeovimApiFunction(name="nvim_buf_is_loaded",
                   since=5)
CompletableFuture<Boolean> isLoaded()

isValid

@NeovimApiFunction(name="nvim_buf_is_valid",
                   since=1)
CompletableFuture<Boolean> isValid()

getMark

@NeovimApiFunction(name="nvim_buf_get_mark",
                   since=1)
CompletableFuture<VimCoords> getMark(String name)

getChangedTick

@NeovimApiFunction(name="nvim_buf_get_changedtick",
                   since=2)
CompletableFuture<Object> getChangedTick()

getKeymap

@NeovimApiFunction(name="nvim_buf_get_keymap",
                   since=3)
CompletableFuture<List<VimKeyMap>> getKeymap(String mode)

setKeymap

@NeovimApiFunction(name="nvim_buf_set_keymap",
                   since=6)
CompletableFuture<Void> setKeymap(String mode,
 String lhs,
 String rhs,
 Map<String,Boolean> options)

deleteKeymap

@NeovimApiFunction(name="nvim_buf_del_keymap",
                   since=6)
CompletableFuture<Void> deleteKeymap(String mode,
 String lhs)

addHighlight

@NeovimApiFunction(name="nvim_buf_add_highlight",
                   since=1)
CompletableFuture<Integer> addHighlight(int srcId,
 String hlGroup,
 int line,
 int colStart,
 int colEnd)

clearHighlight

@NeovimApiFunction(name="nvim_buf_clear_highlight",
                   since=1)
CompletableFuture<Void> clearHighlight(int srcId,
 int lineStart,
 int lineEnd)

clearNamespace

@NeovimApiFunction(name="nvim_buf_clear_namespace",
                   since=5)
CompletableFuture<Void> clearNamespace(int namespaceId,
 int lineStart,
 int lineEnd)

setVirtualText

@NeovimApiFunction(name="nvim_buf_set_virtual_text",
                   since=5)
CompletableFuture<Integer> setVirtualText(int namespaceId,
 int line,
 List<HighlightedText> chunks,
 Map optionalParams)

attach

@NeovimApiFunction(name="nvim_buf_attach",
                   since=4)
CompletableFuture<Boolean> attach(boolean loadFullBufferOnStart,
 Map opts)

detach

@NeovimApiFunction(name="nvim_buf_detach",
                   since=4)
CompletableFuture<Boolean> detach()

getCommands

@NeovimApiFunction(name="nvim_buf_get_commands",
                   since=4)
CompletableFuture<Map<String,CommandInfo>> getCommands(GetCommandsOptions commandsOptions)

setText

@NeovimApiFunction(name="nvim_buf_set_text",
                   since=7)
CompletableFuture<Void> setText(int startRow,
 int startCol,
 int endRow,
 int endCol,
 List<String> lines)

delete

@NeovimApiFunction(name="nvim_buf_delete",
                   since=7)
CompletableFuture<Void> delete(DeleteBufferOptions options)

call

@NeovimApiFunction(name="nvim_buf_call",
                   since=7)
CompletableFuture<Object> call(Object luaFun)

getExtmarkById

@NeovimApiFunction(name="nvim_buf_get_extmark_by_id",
                   since=7)
CompletableFuture<VimCoords> getExtmarkById(int nsId,
 int extmarkId,
 GetBufferExtmarkOptions options)

getExtmarks

@NeovimApiFunction(name="nvim_buf_get_extmarks",
                   since=7)
CompletableFuture<List<ExtmarkInfo>> getExtmarks(int nsId,
 VimCoords start,
 VimCoords end,
 GetBufferExtmarksOptions options)

setExtmark

@NeovimApiFunction(name="nvim_buf_set_extmark",
                   since=7)
CompletableFuture<Integer> setExtmark(int nsId,
 int line,
 int col,
 Map<String,Object> options)

deleteExtmark

@NeovimApiFunction(name="nvim_buf_del_extmark",
                   since=7)
CompletableFuture<Boolean> deleteExtmark(int nsId,
 int extmarkId)

deleteMark

@NeovimApiFunction(name="nvim_buf_del_mark",
                   since=8)
CompletableFuture<Boolean> deleteMark(String name)

setMark

@NeovimApiFunction(name="nvim_buf_set_mark",
                   since=8)
CompletableFuture<Boolean> setMark(String name,
 int line,
 int col,
 Map<String,Object> options)

getText

@NeovimApiFunction(name="nvim_buf_get_text",
                   since=9)
CompletableFuture<List<String>> getText(int startRow,
 int startCol,
 int endRow,
 int endCol,
 Map<String,Object> options)

createUserCommand

@NeovimApiFunction(name="nvim_buf_create_user_command",
                   since=9)
CompletableFuture<Void> createUserCommand(String name,
 String command,
 Map<String,Object> options)

deleteUserCommand

@NeovimApiFunction(name="nvim_buf_del_user_command",
                   since=9)
CompletableFuture<Void> deleteUserCommand(String name)