Package io.github.jspinak.brobot.action.basic.mouse

Class MouseUpOptions

java.lang.Object

io.github.jspinak.brobot.action.ActionConfig

io.github.jspinak.brobot.action.basic.mouse.MouseUpOptions

public final class MouseUpOptions
extends ActionConfig

Configuration for MouseUp actions.

This class extends ActionConfig and composes MousePressOptions to provide settings for mouse button release operations. Following the composition pattern, it reuses MousePressOptions but only utilizes the relevant timing parameters (pauseBeforeMouseUp and pauseAfterMouseUp).

It is an immutable object and must be constructed using its inner MouseUpOptions.Builder.

See Also:

• ActionConfig
• MousePressOptions
• MouseUp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MouseUpOptions.Builder	Builder for constructing MouseUpOptions with a fluent API.

Nested classes/interfaces inherited from class io.github.jspinak.brobot.action.ActionConfig

ActionConfig.Illustrate

Method Summary

Modifier and Type	Method	Description
MouseButton	getButton()	Convenience getter for the mouse button.
MousePressOptions	getMousePressOptions()
double	getPauseAfterMouseUp()	Convenience getter for pause after mouse up.
double	getPauseBeforeMouseUp()	Convenience getter for pause before mouse up.

Methods inherited from class io.github.jspinak.brobot.action.ActionConfig

getAfterActionLog, getBeforeActionLog, getFailureLog, getIllustrate, getPauseAfterEnd, getPauseBeforeBegin, getSubsequentActions, getSuccessCriteria, getSuccessLog

Methods inherited from class java.lang.Object

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

Method Details

getButton

public MouseButton getButton()

Convenience getter for the mouse button.

Returns:

The mouse button to release

getPauseBeforeMouseUp

public double getPauseBeforeMouseUp()

Convenience getter for pause before mouse up.

Returns:

The pause duration before releasing the button

getPauseAfterMouseUp

public double getPauseAfterMouseUp()

Convenience getter for pause after mouse up.

Returns:

The pause duration after releasing the button

getMousePressOptions

public MousePressOptions getMousePressOptions()