Verified Owner
Top Fields Constructors Methods
org.jabref.gui.walkthrough.declarative.effect

public final Record WalkthroughEffect

extends Record
Class Inheritance
Record Components
windowEffects:@NonNull List<WindowEffect> 
fallbackEffect:Optional<HighlightEffect> 
Imports
java.util.List, .Optional, org.jspecify.annotations.NonNull

Field Summary

Modifier and TypeField and Description
private final Optional<HighlightEffect>
fallbackEffect

Record Component accessed by fallbackEffect().

private final @NonNull List<WindowEffect>
windowEffects

Record Component accessed by windowEffects().

Constructor Summary

AccessConstructor and Description
public
WalkthroughEffect(WindowEffect windowEffect)

public
WalkthroughEffect(WindowEffect windowEffect, HighlightEffect fallback)

public
WalkthroughEffect(WindowEffect... windowEffects)

public
WalkthroughEffect(HighlightEffect fallback, WindowEffect... windowEffects)

public
WalkthroughEffect(@NonNull List<WindowEffect> windowEffects, Optional<HighlightEffect> fallbackEffect)

Method Summary

Modifier and TypeMethod and Description
public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

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

public Optional<HighlightEffect>
fallbackEffect()

Record Component getter of fallbackEffect.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

public @NonNull List<WindowEffect>
windowEffects()

Record Component getter of windowEffects.

Field Detail

fallbackEffectback to summary
private final Optional<HighlightEffect> fallbackEffect

Record Component accessed by fallbackEffect().

windowEffectsback to summary
private final @NonNull List<WindowEffect> windowEffects

Record Component accessed by windowEffects().

Constructor Detail

WalkthroughEffectback to summary
public WalkthroughEffect(WindowEffect windowEffect)
WalkthroughEffectback to summary
public WalkthroughEffect(WindowEffect windowEffect, HighlightEffect fallback)
WalkthroughEffectback to summary
public WalkthroughEffect(WindowEffect... windowEffects)
WalkthroughEffectback to summary
public WalkthroughEffect(HighlightEffect fallback, WindowEffect... windowEffects)
WalkthroughEffectback to summary
public WalkthroughEffect(@NonNull List<WindowEffect> windowEffects, Optional<HighlightEffect> fallbackEffect)

Method Detail

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).
fallbackEffectback to summary
public Optional<HighlightEffect> fallbackEffect()

Record Component getter of fallbackEffect.

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.

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.

windowEffectsback to summary
public @NonNull List<WindowEffect> windowEffects()

Record Component getter of windowEffects.