Verified Owner
Top Description Inners Fields Constructors Methods
org.jabref.gui.walkthrough.declarative.step

public final Record SideEffect

extends Record
implements WalkthroughStep
Class Inheritance
All Implemented Interfaces
org.jabref.gui.walkthrough.declarative.step.WalkthroughStep
Record Components
title:@NonNull String 
sideEffect:@NonNull WalkthroughSideEffect 
Imports
org.jabref.gui.walkthrough.declarative.sideeffect.WalkthroughSideEffect, org.jspecify.annotations.NonNull

A walkthrough step that executes side effects without displaying any UI.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private final @NonNull WalkthroughSideEffect
sideEffect

Record Component accessed by sideEffect().

private final @NonNull String
title

Record Component accessed by title().

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static SideEffect.Builder
public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public @NonNull WalkthroughSideEffect
sideEffect()

Record Component getter of sideEffect.

public @NonNull String
public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

sideEffectback to summary
private final @NonNull WalkthroughSideEffect sideEffect

Record Component accessed by sideEffect().

titleback to summary
private final @NonNull String title

Record Component accessed by title().

Constructor Detail

SideEffectback to summary
public SideEffect(@NonNull String title, @NonNull WalkthroughSideEffect sideEffect)

Method Detail

builderback to summary
public static SideEffect.Builder builder(@NonNull String title)
equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

sideEffectback to summary
public @NonNull WalkthroughSideEffect sideEffect()

Record Component getter of sideEffect.

titleback to summary
public @NonNull String title()

Record Component getter of title.

Implements org.jabref.gui.walkthrough.declarative.step.WalkthroughStep.title.

toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

org.jabref.gui.walkthrough.declarative.step back to summary

public Class SideEffect.Builder

extends Object
Class Inheritance
  • java.lang.Object
  • org.jabref.gui.walkthrough.declarative.step.SideEffect.Builder

Field Summary

Modifier and TypeField and Description
private WalkthroughSideEffect
private final String

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public SideEffect
public SideEffect.Builder
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

sideEffectback to summary
private WalkthroughSideEffect sideEffect
titleback to summary
private final String title

Constructor Detail

Builderback to summary
private Builder(@NonNull String title)

Method Detail

buildback to summary
public SideEffect build()
sideEffectback to summary
public SideEffect.Builder sideEffect(@NonNull WalkthroughSideEffect sideEffect)