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, Cloneable

public class Action<D>
extends OperationBase
implements Cloneable

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface com.microsoft.azure.toolkit.lib.common.operation.Operation

Operation.Type

Field Summary

Fields

Modifier and Type	Field	Description
static Action.Id<Object>	AUTHENTICATE
private java.util.function.Predicate<D>	authRequiredProvider
static String	COMMON
static Action.Id<Object>	DISABLE_AUTH_CACHE
static String	EMPTY_PLACE
private java.util.function.Predicate<D>	enableWhen
private List<org.apache.commons.lang3.tuple.Pair<java.util.function.BiPredicate<D,?>,java.util.function.BiConsumer<D,?>>>	handlers
private java.util.function.Function<D,String>	iconProvider
private Action.Id<D>	id
private java.util.function.Function<D,String>	labelProvider
static Action.Id<Object>	OPEN_AZURE_SETTINGS
private String	place
static String	PLACE
static Action.Id<Runnable>	REQUIRE_AUTH
static String	RESOURCE_TYPE
private Object	shortcut	shortcuts for this action.
private D	source
static String	SOURCE
private List<java.util.function.Function<D,String>>	titleParamProviders
private java.util.function.Function<D,AzureString>	titleProvider
private java.util.function.BiPredicate<Object,String>	visibleWhen

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

UNKNOWN_NAME

Constructor Summary

Constructors

Constructor	Description
Action(Action.Id<D> id)

Method Summary

Modifier and Type	Method	Description
Action<D>	bind(D source)
Action<D>	enableWhen(java.util.function.Predicate<D> enableWhen)
Callable<?>	getBody()
AzureString	getDescription()
java.util.function.BiConsumer<D,Object>	getHandler(D s, Object e)
String	getId()
AzureString	getTitle(D s)
String	getType()
IView.Label	getView(D s)
IView.Label	getView(D s, String place)
void	handle(D s)
void	handle(D s, Object e)
private void	handle(D s, Object e, java.util.function.BiConsumer<D,Object> handler)
private boolean	isAuthRequired(D s)
static <D> Boolean	isAuthRequiredForAzureResource(D resource)
void	register(AzureActionManager am)
static Action<Void>	retryFromFailure(Runnable handler)
String	toString()
Action<D>	visibleWhen(java.util.function.BiPredicate<Object,String> visibleWhen)
Action<D>	visibleWhen(java.util.function.Predicate<Object> visibleWhen)
Action<D>	withAuthRequired(boolean authRequired)
Action<D>	withAuthRequired(java.util.function.Predicate<D> authRequiredProvider)
<E> Action<D>	withHandler(java.util.function.BiConsumer<D,E> handler)
<E> Action<D>	withHandler(java.util.function.BiPredicate<D,E> condition, java.util.function.BiConsumer<D,E> handler)
Action<D>	withHandler(java.util.function.Consumer<D> handler)
Action<D>	withHandler(java.util.function.Predicate<D> condition, java.util.function.Consumer<D> handler)
Action<D>	withIcon(String icon)
Action<D>	withIcon(java.util.function.Function<D,String> iconProvider)
Action<D>	withIdParam(String titleParam)
Action<D>	withIdParam(java.util.function.Function<D,String> titleParamProvider)
Action<D>	withLabel(String label)
Action<D>	withLabel(java.util.function.Function<D,String> labelProvider)
Action<D>	withShortcut(Object shortcut)
Action<D>	withTitle(AzureString title)

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, 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

PLACE

public static final String PLACE

See Also:

Constant Field Values

EMPTY_PLACE

public static final String EMPTY_PLACE

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

OPEN_AZURE_SETTINGS

public static final Action.Id<Object> OPEN_AZURE_SETTINGS

DISABLE_AUTH_CACHE

public static final Action.Id<Object> DISABLE_AUTH_CACHE

COMMON

public static final String COMMON

See Also:

Constant Field Values

id

@Nonnull
private final Action.Id<D> id

enableWhen

@Nonnull
private java.util.function.Predicate<D> enableWhen

visibleWhen

private java.util.function.BiPredicate<Object,String> visibleWhen

iconProvider

private java.util.function.Function<D,String> iconProvider

labelProvider

private java.util.function.Function<D,String> labelProvider

titleProvider

private java.util.function.Function<D,AzureString> titleProvider

handlers

@Nonnull
private List<org.apache.commons.lang3.tuple.Pair<java.util.function.BiPredicate<D,?>,java.util.function.BiConsumer<D,?>>> handlers

titleParamProviders

@Nonnull
private List<java.util.function.Function<D,String>> titleParamProviders

source

private D source

place

private String place

authRequiredProvider

private java.util.function.Predicate<D> authRequiredProvider

shortcut

private Object shortcut

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)

Method Detail

getId

@Nonnull
public String getId()

Specified by:

getId in interface Operation

getView

public IView.Label getView(D s)

getView

@Nonnull
public IView.Label getView(D s,
                           String place)

getHandler

@Nullable
public java.util.function.BiConsumer<D,Object> getHandler(D s,
                                                                Object e)

handle

public void handle(D s,
                   Object e)

handle

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

handle

public void handle(D s)

getBody

public Callable<?> getBody()

Specified by:

getBody in interface Operation

getType

@Nonnull
public String getType()

Specified by:

getType in interface Operation

isAuthRequired

private boolean isAuthRequired(D s)

getTitle

public AzureString getTitle(D s)

getDescription

@Nonnull
public AzureString getDescription()

Specified by:

getDescription in interface Operation

enableWhen

public Action<D> enableWhen(@Nonnull
                            java.util.function.Predicate<D> enableWhen)

visibleWhen

public Action<D> visibleWhen(@Nonnull
                             java.util.function.Predicate<Object> visibleWhen)

visibleWhen

public Action<D> visibleWhen(@Nonnull
                             java.util.function.BiPredicate<Object,String> visibleWhen)

withLabel

public Action<D> withLabel(@Nonnull
                           String label)

withLabel

public Action<D> withLabel(@Nonnull
                           java.util.function.Function<D,String> labelProvider)

withIcon

public Action<D> withIcon(@Nonnull
                          String icon)

withIcon

public Action<D> withIcon(@Nonnull
                          java.util.function.Function<D,String> iconProvider)

withTitle

public Action<D> withTitle(@Nonnull
                           AzureString title)

withShortcut

public Action<D> withShortcut(@Nonnull
                              Object shortcut)

withHandler

public Action<D> withHandler(@Nonnull
                             java.util.function.Consumer<D> handler)

withHandler

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

withHandler

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

withHandler

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

withAuthRequired

public Action<D> withAuthRequired(boolean authRequired)

withAuthRequired

public Action<D> withAuthRequired(@Nonnull
                                  java.util.function.Predicate<D> authRequiredProvider)

withIdParam

public Action<D> withIdParam(@Nonnull
                             String titleParam)

withIdParam

public Action<D> withIdParam(@Nonnull
                             java.util.function.Function<D,String> titleParamProvider)

bind

public Action<D> bind(D source)

register

public void register(AzureActionManager am)

toString

public String toString()

Overrides:

toString in class Object

retryFromFailure

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

isAuthRequiredForAzureResource

public static <D> Boolean isAuthRequiredForAzureResource(@Nullable
                                                         D resource)