Module io.aiven.commons.kafka.config

Package io.aiven.commons.kafka.config

Class SinceInfo

java.lang.Object

io.aiven.commons.kafka.config.SinceInfo

public final class SinceInfo
extends Object

Contains the information about when this option was added. Since options can be added at various stages and by different libraries and because the "since" field is to assist users in determining at what version an option became available in the final connector the SinceInfo tracks the module and version where the option was added but provides a mechanism to override the display in the final configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SinceInfo.Builder	A builder for SinceInfo and the SinceInfo override.
static final record	SinceInfo.Data	Record of the data to display.
static final class	SinceInfo.OverrideRange	Matches a range of SinceInfo records.

Method Summary

Modifier and Type	Method	Description
org.apache.maven.artifact.versioning.ArtifactVersion	artifactVersion()	Gets the parsed ArtifactVersion for this sinceInfo.
static SinceInfo.Builder	builder()	The builder for SinceInfo and SinceInfo overrides.
void	setOverride(SinceInfo.Builder builder)	Sets the override for this SinceInfo.
void	setOverride(Map<SinceInfo.OverrideRange,SinceInfo.Data> overrideMap)	Sets the override from the Builder associated with the matching OverrideRange in the overrideMap.
SinceInfo	setVersionOnly()	Sets the override to be just the version of this component.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

setOverride

public void setOverride(SinceInfo.Builder builder)

Sets the override for this SinceInfo. The builder must define version. The groupId and artifactId are optional and will be displayed if present.

Parameters:

builder - the builder to define the override.

setOverride

public void setOverride(Map<SinceInfo.OverrideRange,SinceInfo.Data> overrideMap)

Sets the override from the Builder associated with the matching OverrideRange in the overrideMap. If multiple ranges match the last one in the map will be applied.

Parameters:

overrideMap - the map of OverrideRanges and builders to apply.

setVersionOnly

public SinceInfo setVersionOnly()

Sets the override to be just the version of this component.

Returns:

this

artifactVersion

public org.apache.maven.artifact.versioning.ArtifactVersion artifactVersion()

Gets the parsed ArtifactVersion for this sinceInfo.

Returns:

the parsed ArtifactVersion for this sinceInfo.

toString

public String toString()

Overrides:

toString in class Object

builder

public static SinceInfo.Builder builder()

The builder for SinceInfo and SinceInfo overrides.

Returns:

the Builder.