Package com.helger.photon.ajax.decl

Class AjaxFunctionDeclaration

java.lang.Object

com.helger.photon.ajax.decl.AjaxFunctionDeclaration

All Implemented Interfaces:

com.helger.commons.name.IHasName, IAjaxFunctionDeclaration

@Immutable
public class AjaxFunctionDeclaration
extends Object
implements IAjaxFunctionDeclaration

Abstract base implementation of IAjaxFunctionDeclaration

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AjaxFunctionDeclaration.Builder	Builder for AjaxFunctionDeclaration objects.

Constructor Summary

Constructors

Constructor	Description
AjaxFunctionDeclaration(String sFunctionName, Supplier<? extends IAjaxExecutor> aExecutorFactory, Predicate<? super com.helger.web.scope.IRequestWebScopeWithoutResponse> aExecutionFilter, String sServletPath)

Method Summary

Modifier and Type	Method	Description
static AjaxFunctionDeclaration.Builder	builder()	Create a function that is not named.
static AjaxFunctionDeclaration.Builder	builder(String sFunctionName)
boolean	canExecute(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope)	Check if this AJAX function can be executed for the passed request.
String	getAjaxServletPath()
Predicate<? super com.helger.web.scope.IRequestWebScopeWithoutResponse>	getExecutionFilter()
Supplier<? extends IAjaxExecutor>	getExecutorFactory()
String	getName()
static int	getUniqueFunctionID()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.ajax.decl.IAjaxFunctionDeclaration

getExecutor, getInvocationURI, getInvocationURI, getInvocationURL, getPathWithoutContext

Constructor Detail

AjaxFunctionDeclaration

public AjaxFunctionDeclaration(@Nonnull @Nonempty
                               String sFunctionName,
                               @Nonnull
                               Supplier<? extends IAjaxExecutor> aExecutorFactory,
                               @Nullable
                               Predicate<? super com.helger.web.scope.IRequestWebScopeWithoutResponse> aExecutionFilter,
                               @Nonnull @Nonempty
                               String sServletPath)

Method Detail

getName

@Nonnull
@Nonempty
public final String getName()

Specified by:

getName in interface com.helger.commons.name.IHasName

getExecutorFactory

@Nonnull
public final Supplier<? extends IAjaxExecutor> getExecutorFactory()

Specified by:

getExecutorFactory in interface IAjaxFunctionDeclaration

Returns:

The executor factory to be used. May not be null.

getExecutionFilter

@Nullable
public final Predicate<? super com.helger.web.scope.IRequestWebScopeWithoutResponse> getExecutionFilter()

Specified by:

getExecutionFilter in interface IAjaxFunctionDeclaration

Returns:

The optional filter to be invoked before the main AJAX invocation. May be null.

canExecute

public boolean canExecute(@Nonnull
                          com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope)

Description copied from interface: IAjaxFunctionDeclaration

Check if this AJAX function can be executed for the passed request.

Specified by:

canExecute in interface IAjaxFunctionDeclaration

Parameters:

aRequestScope - The request scope to be used for evaluation. Never null .

Returns:

true if this AJAX function can be executed, false otherwise.

getAjaxServletPath

@Nonnull
@Nonempty
public String getAjaxServletPath()

Specified by:

getAjaxServletPath in interface IAjaxFunctionDeclaration

Returns:

The path to the AJAX servlet. Must start with a slash and end with a slash!

toString

public String toString()

Overrides:

toString in class Object

builder

@Nonnull
public static AjaxFunctionDeclaration.Builder builder()

Create a function that is not named. The created name is ensured to be unique. The registration is removed once the global context is shutdown so the created path is not durable, as the next time the context is initialized a different number might be assigned. Use builder(String) for a permanent name.

Returns:

A new function declaration builder. Never null.

See Also:

builder(String)

getUniqueFunctionID

public static int getUniqueFunctionID()

builder

@Nonnull
public static AjaxFunctionDeclaration.Builder builder(@Nullable
                                                      String sFunctionName)