io.sightly.java.api

Class ProviderOutcome

java.lang.Object

io.sightly.java.api.ProviderOutcome

Deprecated.

as of bundle version 1.1.68. Implementations of the Sling org.apache.sling.scripting.sightly.use.UseProvider interface return Sling org.apache.sling.scripting.sightly.use.ProviderOutcome objects.

@Deprecated
public final class ProviderOutcome
extends Object

Result returned by a use provider

Method Summary

Methods

Modifier and Type	Method and Description
static ProviderOutcome	failure() Deprecated. Create a failed outcome
Object	getResult() Deprecated. Get the result in this outcome
boolean	isFailure() Deprecated. Check whether the outcome is a failure
boolean	isSuccess() Deprecated. Check if the outcome has been successful
static ProviderOutcome	notNullOrFailure(Object obj) Deprecated. If the given obj is not null return a successful outcome, with the given result.
static ProviderOutcome	success(Object result) Deprecated. Create a successful outcome

Methods inherited from class java.lang.Object

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

Method Detail

success

public static ProviderOutcome success(Object result)

Deprecated.

Create a successful outcome

Parameters:

result - the result

Returns:

a successful result

failure

public static ProviderOutcome failure()

Deprecated.

Create a failed outcome

Returns:

a failed outcome

notNullOrFailure

public static ProviderOutcome notNullOrFailure(Object obj)

Deprecated.

If the given obj is not null return a successful outcome, with the given result. Otherwise, return failure

Parameters:

obj - the result

Returns:

an outcome based on whether the parameter is null or not

isSuccess

public boolean isSuccess()

Deprecated.

Check if the outcome has been successful

Returns:

the outcome success status

isFailure

public boolean isFailure()

Deprecated.

Check whether the outcome is a failure

Returns:

the outcome failure status

getResult

public Object getResult()

Deprecated.

Get the result in this outcome

Returns:

the result of the container

Throws:

UnsupportedOperationException - if the outcome is a failure