Package io.jenkins.plugins.configsplice.engine

Record Class SplicePlan.Edit

java.lang.Object

java.lang.Record

io.jenkins.plugins.configsplice.engine.SplicePlan.Edit

Record Components:

range - the exact source range of the existing scalar token

replacement - already-serialised replacement text for this context (JSON literal, or XML-escaped attribute content)

label - a value-free identifier used only in diagnostics, typically the property path

Enclosing class:

SplicePlan

public static record SplicePlan.Edit(SourceRange range, String replacement, String label)
extends Record

One replacement.

Constructor Summary

Constructors

Constructor	Description
Edit(SourceRange range, String replacement, String label)	Creates an instance of a Edit record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	label()	Returns the value of the label record component.
SourceRange	range()	Returns the value of the range record component.
String	replacement()	Returns the value of the replacement record component.
String	toString()	Masks the replacement text.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Edit

public Edit(SourceRange range,
 String replacement,
 String label)

Creates an instance of a Edit record class.

Parameters:

range - the value for the range record component

replacement - the value for the replacement record component

label - the value for the label record component

Method Details

toString

public String toString()

Masks the replacement text.

A record's generated toString() prints every component, so the default would put a resolved credential into any log statement, assertion message or debugger label that touched an edit. Overriding it makes that leak impossible rather than merely forbidden (ADR-003).

Specified by:

toString in class Record

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

range

public SourceRange range()

Returns the value of the range record component.

Returns:

the value of the range record component

replacement

public String replacement()

Returns the value of the replacement record component.

Returns:

the value of the replacement record component

label

public String label()

Returns the value of the label record component.

Returns:

the value of the label record component