@PublicApi public interface

ServiceOutcome

implements ServiceResult
com.atlassian.jira.bc.ServiceOutcome<T>
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

A service result that has a value.

Summary

Public Methods
<R> R fold(Function<? super T, R> onSuccess, Function<? super ErrorCollection, R> onFailure)
Folds this outcome into a value using the given functions.
T get()
Returns the value that was returned by the service, or null.
T getReturnedValue()
Returns the value that was returned by the service, or null.
[Expand]
Inherited Methods
From interface com.atlassian.jira.bc.ServiceResult

Public Methods

public R fold (Function<? super T, R> onSuccess, Function<? super ErrorCollection, R> onFailure)

Folds this outcome into a value using the given functions. Note that this method does not provide access to any warnings returned by getWarningCollection(). If your use case requires you to process warnings, use the other methods in this interface.

Parameters
onSuccess the function to apply when isValid() returns true
onFailure the function to apply when isValid() returns false
Returns
  • see above

public T get ()

Returns the value that was returned by the service, or null.

Returns
  • the value returned by the service, or null

public T getReturnedValue ()

Returns the value that was returned by the service, or null.

Returns
  • the value returned by the service, or null