com.almworks.jira.structure.api.effector

Class EffectorFunctionResponse

Object

EffectorFunctionResponse

Direct Known Subclasses:

EffectorFunctionResponse.Errors, EffectorFunctionResponse.Valid

@PublicApi
public abstract class EffectorFunctionResponse
extends Object

A response object returned by Effector.getEffectorFunction(Map, EffectorContext), containing either an EffectorFunction or a collection of error messages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EffectorFunctionResponse.Errors An invalid effector response with error messages.
static class	EffectorFunctionResponse.Valid A valid effector response.

Method Summary

Modifier and Type	Method and Description
static EffectorFunctionResponse	error(String i18nKey, Object... parameters) Constructs and returns an error response with a single error message.
static EffectorFunctionResponse	errors(I18nText... errors) Constructs and returns an error response with one or more error messages.
static EffectorFunctionResponse	errors(List<I18nText> errors) Constructs and returns an error response with one or more error messages.
static EffectorFunctionResponse	valid(EffectorFunction effectorFunction) Constructs and returns a valid response.

Methods inherited from class Object

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

Method Detail

valid

public static EffectorFunctionResponse valid(@NotNull
                                             EffectorFunction effectorFunction)

Constructs and returns a valid response.

Parameters:

effectorFunction - the returned effector function

Returns:

a valid response

error

public static EffectorFunctionResponse error(@NotNull
                                             String i18nKey,
                                             Object... parameters)

Constructs and returns an error response with a single error message.

Parameters:

i18nKey - i18n key for the error message

parameters - parameters for the error message

Returns:

an error response

errors

public static EffectorFunctionResponse errors(@NotNull
                                              I18nText... errors)

Constructs and returns an error response with one or more error messages.

Parameters:

errors - error messages

Returns:

an error response

Throws:

IllegalArgumentException - if no error messages are given

errors

public static EffectorFunctionResponse errors(@NotNull
                                              List<I18nText> errors)

Constructs and returns an error response with one or more error messages.

Parameters:

errors - error messages

Returns:

an error response

Throws:

IllegalArgumentException - if no error messages are given