Module lettuce.core

Package io.lettuce.core.dynamic.segment

Class CommandSegment

java.lang.Object

io.lettuce.core.dynamic.segment.CommandSegment

public abstract class CommandSegment
extends Object

Value object representing a segment within a Redis Command.

A command segment is an ASCII string denoting a command, a named or an index-parameter reference.

Since:

5.0

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandSegment.ArgumentContribution

Constructor Summary

Constructors

Constructor	Description
CommandSegment()

Method Summary

Modifier and Type	Method	Description
abstract String	asString()
abstract boolean	canConsume(Parameter parameter)	Check whether this segment can consume the Parameter by applying parameter substitution.
static CommandSegment	constant(String content)	Create a constant CommandSegment.
abstract CommandSegment.ArgumentContribution	contribute(MethodParametersAccessor parametersAccessor)
static CommandSegment	indexedParameter(int index)
static CommandSegment	namedParameter(String name)	Create a named parameter reference CommandSegment.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CommandSegment

public CommandSegment()

Method Details

constant

public static CommandSegment constant(String content)

Create a constant CommandSegment.

Parameters:

content - must not be empty or null.

Returns:

the CommandSegment.

namedParameter

public static CommandSegment namedParameter(String name)

Create a named parameter reference CommandSegment.

Parameters:

name - must not be empty or null.

Returns:

indexedParameter

public static CommandSegment indexedParameter(int index)

asString

public abstract String asString()

Returns:

the command segment in its representation

canConsume

public abstract boolean canConsume(Parameter parameter)

Check whether this segment can consume the Parameter by applying parameter substitution.

Parameters:

parameter -

Returns:

Since:

5.1.3

contribute

public abstract CommandSegment.ArgumentContribution contribute(MethodParametersAccessor parametersAccessor)

Parameters:

parametersAccessor -

Returns:

toString

public String toString()

Overrides:

toString in class Object