Package com.microsoft.azure.toolkit.lib.common.action

Class Action<D>

java.lang.Object

com.microsoft.azure.toolkit.lib.common.operation.OperationBase

com.microsoft.azure.toolkit.lib.common.action.Action<D>

All Implemented Interfaces:

Operation

public class Action<D>
extends OperationBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Action.Id<D>

Field Summary

Fields

Modifier and Type	Field	Description
static Action.Id<Object>	AUTHENTICATE
private boolean	authRequired
private List<AbstractMap.SimpleEntry<java.util.function.BiPredicate<D,?>,java.util.function.BiConsumer<D,?>>>	handlers
private Action.Id<D>	id
static Action.Id<Runnable>	REQUIRE_AUTH
static String	RESOURCE_TYPE
private Object	shortcuts	shortcuts for this action.
static String	SOURCE
private ActionView.Builder	viewBuilder

Fields inherited from interface com.microsoft.azure.toolkit.lib.common.operation.Operation

UNKNOWN_NAME

Constructor Summary

Constructors

Constructor	Description
Action(Action.Id<D> id, ActionView.Builder viewBuilder)
Action(Action.Id<D> id, java.util.function.BiConsumer<D,E> handler)
Action(Action.Id<D> id, java.util.function.BiConsumer<D,E> handler, ActionView.Builder viewBuilder)
Action(Action.Id<D> id, java.util.function.Consumer<D> handler)
Action(Action.Id<D> id, java.util.function.Consumer<D> handler, ActionView.Builder viewBuilder)

Method Summary

Modifier and Type	Method	Description
Callable<?>	getBody()
AzureString	getDescription()
java.util.function.BiConsumer<D,Object>	getHandler(D source, Object e)
String	getId()
String	getType()
IView.Label	getView(D source)
void	handle(D source)
void	handle(D source, Object e)
protected void	handle(D source, Object e, java.util.function.BiConsumer<D,Object> handler)
<E> void	registerHandler(java.util.function.BiPredicate<D,E> condition, java.util.function.BiConsumer<D,E> handler)
void	registerHandler(java.util.function.Predicate<D> condition, java.util.function.Consumer<D> handler)
static Action<Void>	retryFromFailure(Runnable handler)

Methods inherited from class com.microsoft.azure.toolkit.lib.common.operation.OperationBase

getContext, getExecutionId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microsoft.azure.toolkit.lib.common.operation.Operation

getActionParent, getEffectiveParent, getParent, setParent

Field Detail

SOURCE

public static final String SOURCE

See Also:

Constant Field Values

RESOURCE_TYPE

public static final String RESOURCE_TYPE

See Also:

Constant Field Values

REQUIRE_AUTH

public static final Action.Id<Runnable> REQUIRE_AUTH

AUTHENTICATE

public static final Action.Id<Object> AUTHENTICATE

handlers

@Nonnull
private final List<AbstractMap.SimpleEntry<java.util.function.BiPredicate<D,?>,java.util.function.BiConsumer<D,?>>> handlers

id

@Nonnull
private final Action.Id<D> id

viewBuilder

@Nullable
private ActionView.Builder viewBuilder

authRequired

private boolean authRequired

shortcuts

private Object shortcuts

shortcuts for this action. 1. directly bound to this action if it's IDE-specific type of shortcuts (e.g. ShortcutSet in IntelliJ). 2. interpreted into native shortcuts first and then bound to this action if it's String[]/String (e.g. "alt X"). 3. copy shortcuts from actions specified by this action id and then bound to this action if it's Action.Id of another action.

Constructor Detail

Action

public Action(@Nonnull
              Action.Id<D> id,
              @Nullable
              ActionView.Builder viewBuilder)

Action

public Action(@Nonnull
              Action.Id<D> id,
              @Nonnull
              java.util.function.Consumer<D> handler)

Action

public Action(@Nonnull
              Action.Id<D> id,
              @Nonnull
              java.util.function.BiConsumer<D,E> handler)

Action

public Action(@Nonnull
              Action.Id<D> id,
              @Nonnull
              java.util.function.Consumer<D> handler,
              @Nullable
              ActionView.Builder viewBuilder)

Action

public Action(@Nonnull
              Action.Id<D> id,
              @Nonnull
              java.util.function.BiConsumer<D,E> handler,
              @Nullable
              ActionView.Builder viewBuilder)

Method Detail

getId

@Nonnull
public String getId()

getView

@Nullable
public IView.Label getView(D source)

getHandler

public java.util.function.BiConsumer<D,Object> getHandler(D source,
                                                                Object e)

handle

public void handle(D source,
                   Object e)

handle

protected void handle(D source,
                      Object e,
                      java.util.function.BiConsumer<D,Object> handler)

handle

public void handle(D source)

registerHandler

public void registerHandler(@Nonnull
                            java.util.function.Predicate<D> condition,
                            @Nonnull
                            java.util.function.Consumer<D> handler)

registerHandler

public <E> void registerHandler(@Nonnull
                                java.util.function.BiPredicate<D,E> condition,
                                @Nonnull
                                java.util.function.BiConsumer<D,E> handler)

getBody

public Callable<?> getBody()

getType

@Nonnull
public String getType()

getDescription

@Nullable
public AzureString getDescription()

retryFromFailure

public static Action<Void> retryFromFailure(@Nonnull
                                            Runnable handler)