Package io.aiven.commons.kafka.connector.common.templating

Class TemplateVariable

java.lang.Object

io.aiven.commons.kafka.connector.common.templating.TemplateVariable

public final class TemplateVariable
extends Object

The template variable definition.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TemplateVariable.Builder	A builder for TemplateVariable instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final TemplateVariable	KEY	The standard key definition
static final TemplateVariable	PARTITION	the standard partition definition
static final TemplateVariable	START_OFFSET	the standard start offset definition
static final TemplateVariable	TIMESTAMP	The standard timestamp definition
static final TemplateVariable	TOPIC	the standard topic definition

Method Summary

Modifier and Type	Method	Description
static TemplateVariable.Builder	builder(String name)	Gets the builder for TemplateVariables.
String	description()	Gets the description of this TemplateVariable.
String	example()	Generates an example of this variable.
String	getName()	Gets the name of the variable.
ParameterDescriptor	getParameterDescriptor()	Gets the parameter descriptor for this variable.
boolean	hasParameter()	Determines if there is a parameter descriptor.
void	validate(String errStr, String template, Parameter parameter)	Validate the parameter against the template variable.

Methods inherited from class java.lang.Object

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

Field Details

KEY

public static final TemplateVariable KEY

The standard key definition

TOPIC

public static final TemplateVariable TOPIC

the standard topic definition

PARTITION

public static final TemplateVariable PARTITION

the standard partition definition

START_OFFSET

public static final TemplateVariable START_OFFSET

the standard start offset definition

TIMESTAMP

public static final TemplateVariable TIMESTAMP

The standard timestamp definition

Method Details

description

public String description()

Gets the description of this TemplateVariable.

Returns:

the description of this template variable.

example

public String example()

Generates an example of this variable.

Returns:

the example text for this variable.

builder

public static TemplateVariable.Builder builder(String name)

Gets the builder for TemplateVariables.

Parameters:

name - name of the variable being built.

Returns:

the Builder.

getName

public String getName()

Gets the name of the variable.

Returns:

the name of the variable.

hasParameter

public boolean hasParameter()

Determines if there is a parameter descriptor.

Returns:

true if there is a descriptor.

getParameterDescriptor

public ParameterDescriptor getParameterDescriptor()

Gets the parameter descriptor for this variable.

Returns:

the parameter descriptor.

validate

public void validate(String errStr,
 String template,
 Parameter parameter)

Validate the parameter against the template variable.

Parameters:

errStr - the error string for this template.

template - the template the parameter was parsed from.

parameter - The parsed parameter