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

Class Action<D>

java.lang.Object

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

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

AzureActionManager.DummyOpenUrlAction

public class Action<D>
extends Object
implements Cloneable

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static Action.Id<Object>	AUTHENTICATE
(package private) java.util.function.Predicate<D>	authRequiredProvider
static String	COMMON_PLACE
static Action.Id<Object>	DISABLE_AUTH_CACHE
static String	EMPTY_PLACE
(package 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
(package private) java.util.function.Function<D,String>	iconProvider
private Action.Id<D>	id
(package private) java.util.function.Function<D,String>	labelProvider
static Action.Id<Object>	OPEN_AZURE_SETTINGS
static Action.Id<String>	OPEN_URL
static String	PLACE
static Action.Id<java.util.function.Consumer<IAccount>>	REQUIRE_AUTH
static String	RESOURCE_TYPE
static Action.Id<Object>	SELECT_SUBS
private Object	shortcut	shortcuts for this action.
static String	SOURCE
(package private) java.util.function.Function<D,Object>	sourceProvider
protected D	target
(package private) List<java.util.function.Function<D,String>>	titleParamProviders
(package private) java.util.function.Function<D,AzureString>	titleProvider
static Action.Id<Object>	TRY_AZURE
(package private) java.util.function.BiPredicate<Object,String>	visibleWhen

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Action<D>	bind(D s)
Action<D>	enableWhen(java.util.function.Predicate<D> enableWhen)
(package private) java.util.function.BiConsumer<D,Object>	getHandler(D s, Object e)
IView.Label	getView(D s)
IView.Label	getView(D s, String place)
void	handle(D s)	perform asynchronously
void	handle(D s, Object e)	perform asynchronously
void	handleSync(D s)	perform asynchronously
void	handleSync(D s, Object e)	perform asynchronously
ActionInstance<D>	instantiate(D s)
ActionInstance<D>	instantiate(D s, Object event)
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>	withSource(Object source)
Action<D>	withSource(java.util.function.Function<D,Object> sourceProvider)
Action<D>	withTitle(AzureString title)

Methods inherited from class java.lang.Object

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

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

AUTHENTICATE

public static final Action.Id<Object> AUTHENTICATE

REQUIRE_AUTH

public static final Action.Id<java.util.function.Consumer<IAccount>> REQUIRE_AUTH

TRY_AZURE

public static final Action.Id<Object> TRY_AZURE

SELECT_SUBS

public static final Action.Id<Object> SELECT_SUBS

OPEN_AZURE_SETTINGS

public static final Action.Id<Object> OPEN_AZURE_SETTINGS

DISABLE_AUTH_CACHE

public static final Action.Id<Object> DISABLE_AUTH_CACHE

OPEN_URL

public static final Action.Id<String> OPEN_URL

COMMON_PLACE

public static final String COMMON_PLACE

See Also:

Constant Field Values

id

@Nonnull
private final Action.Id<D> id

handlers

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

target

protected D target

enableWhen

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

visibleWhen

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

iconProvider

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

labelProvider

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

titleProvider

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

titleParamProviders

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

sourceProvider

java.util.function.Function<D,Object> sourceProvider

authRequiredProvider

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

getView

public IView.Label getView(D s)

getView

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

handle

public void handle(D s)

perform asynchronously

handle

public void handle(D s,
                   Object e)

perform asynchronously

handleSync

public void handleSync(D s)

perform asynchronously

handleSync

public void handleSync(D s,
                       Object e)

perform asynchronously

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)

withSource

public Action<D> withSource(@Nonnull
                            Object source)

withSource

public Action<D> withSource(@Nonnull
                            java.util.function.Function<D,Object> sourceProvider)

getHandler

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

bind

public Action<D> bind(D s)

instantiate

@Nonnull
public ActionInstance<D> instantiate(D s)

instantiate

@Nonnull
public ActionInstance<D> instantiate(D s,
                                     Object event)

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)