DataResult (datafixerupper 4.0.0-SNAPSHOT API)

java.lang.Object
- com.mojang.serialization.DataResult<R>

Type Parameters:

R - The type of the wrapped result.

All Implemented Interfaces:

DataResult<R>
```
public class DataResult<R>
extends Object
```
Represents either a successful operation, or a partial operation with an error message and a partial result (if available). Also stores an additional lifecycle marker (monoidal).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataResult.Instance` The applicative functor type instance for the type constructor `DataResult`.
`static class`	`DataResult.PartialResult<R>` A container for a partial result in an error `DataResult`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataResult<R>`	`addLifecycle(Lifecycle lifecycle)` Returns a `DataResult` with the same value as this result, but with the provided lifecycle added to this result's lifecycle.
`<R2> DataResult<R2>`	`ap(DataResult<(R) -> R2> functionResult)` Applies a function which is itself wrapped in a `DataResult` to the result or partial result.
`<R2,S> DataResult<S>`	`apply2((R,R2) -> S function, DataResult<R2> second)` Combines this result with another result using the given function.
`<R2,S> DataResult<S>`	`apply2stable((R,R2) -> S function, DataResult<R2> second)` Combines this result with another result using the given function, under the "stable" lifecycle.
`<R2,R3,S> DataResult<S>`	`apply3((R,R2,R3) -> S function, DataResult<R2> second, DataResult<R3> third)` Combines this result with two other results using the given function.
`boolean`	`equals(Object o)`
`Optional<DataResult.PartialResult<R>>`	`error()` Returns the error `DataResult.PartialResult`, if one is present.
`static <R> DataResult<R>`	`error(String message)` Creates an error `DataResult` with the given message and no partial result.
`static <R> DataResult<R>`	`error(String message, Lifecycle lifecycle)` Creates an error `DataResult` with the given message and lifecycle.
`static <R> DataResult<R>`	`error(String message, R partialResult)` Creates an error `DataResult` with the given message and partial result value.
`static <R> DataResult<R>`	`error(String message, R partialResult, Lifecycle lifecycle)` Creates an error `DataResult` with the given message, partial result value, and lifecycle.
`<R2> DataResult<R2>`	`flatMap((? super R) -> ? extends DataResult<R2> function)` Applies the function to either full or partial result, in case of partial concatenates errors.
`(R\|DataResult.PartialResult<R>)`	`get()` Returns the wrapped `Either`.
`R`	`getOrThrow(boolean allowPartial, (String) -> void onError)` Unsafely gets the result stored in this `DataResult`.
`int`	`hashCode()`
`static instance DataResult<_>`	`instance()` Returns the applicative type instance for the type `DataResult`.
`Lifecycle`	`lifecycle()` Returns the lifecycle used in this `DataResult`.
`<T> DataResult<T>`	`map((? super R) -> ? extends T function)` Applies a function to the result or partial result.
`DataResult<R>`	`mapError((String) -> String function)` Applies the given function to the error message contained in this result.
`static <K,V> (K) -> DataResult<V>`	`partialGet((K) -> V partialGet, by-name String errorPrefix)` Converts a partial function into a function that produces a `DataResult`.
`DataResult<R>`	`promotePartial((String) -> void onError)` Promotes an error with a partial result to a success.
`Optional<R>`	`result()` Returns the successful result, if one is present.
`Optional<R>`	`resultOrPartial((String) -> void onError)` Returns any result, if one is present.
`DataResult<R>`	`setLifecycle(Lifecycle lifecycle)` Returns a `DataResult` with the same value as this result, but with the provided lifecycle.
`DataResult<R>`	`setPartial(R partial)` If this result is an error, replaces any partial result with the given partial result.
`DataResult<R>`	`setPartial(by-name R partial)` If this result is an error, replaces any partial result with the supplied partial result.
`static <R> DataResult<R>`	`success(R result)` Creates a successful `DataResult` with the given result value.
`static <R> DataResult<R>`	`success(R result, Lifecycle experimental)` Creates a successful `DataResult` with the given result value and lifecycle.
`String`	`toString()` Returns a `String` describing this `DataResult`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - success
```
public static <R> DataResult<R> success(R result)
```
    Creates a successful DataResult with the given result value. The lifecycle of the result is experimental.
    
    Type Parameters:
    
    R - The type of the result value.
    
    Parameters:
    
    result - The result value.
    
    Returns:
    
    A successful DataResult.
    
    See Also:
    
    success(Object, Lifecycle)
  - error
```
public static <R> DataResult<R> error(String message,
                                      R partialResult)
```
    Creates an error DataResult with the given message and partial result value.
    
    Type Parameters:
    
    R - The type of the result value.
    
    Parameters:
    
    message - The error message.
    
    partialResult - The partial or fallback result value.
    
    Returns:
    
    An error DataResult.
    
    See Also:
    
    error(String, Object, Lifecycle)
  - error
```
public static <R> DataResult<R> error(String message)
```
    Creates an error DataResult with the given message and no partial result.
    
    Type Parameters:
    
    R - The expected type of the result.
    
    Parameters:
    
    message - The error message.
    
    Returns:
    
    An error DataResult.
    
    See Also:
    
    error(String, Object)
  - success
```
public static <R> DataResult<R> success(R result,
                                        Lifecycle experimental)
```
    Creates a successful DataResult with the given result value and lifecycle.
    
    Type Parameters:
    
    R - The type of the result value.
    
    Parameters:
    
    result - The result value.
    
    experimental - The lifecycle to use.
    
    Returns:
    
    A successful DataResult.
    
    See Also:
    
    success(Object, Lifecycle)
  - error
```
public static <R> DataResult<R> error(String message,
                                      R partialResult,
                                      Lifecycle lifecycle)
```
    Creates an error DataResult with the given message, partial result value, and lifecycle.
    
    Type Parameters:
    
    R - The type of the result value.
    
    Parameters:
    
    message - The error message.
    
    partialResult - The partial or fallback result value.
    
    lifecycle - The lifecycle to use.
    
    Returns:
    
    An error DataResult.
  - error
```
public static <R> DataResult<R> error(String message,
                                      Lifecycle lifecycle)
```
    Creates an error DataResult with the given message and lifecycle.
    
    Type Parameters:
    
    R - The expected type of the result.
    
    Parameters:
    
    message - The error message.
    
    lifecycle - The lifecycle to use.
    
    Returns:
    
    An error DataResult.
    
    See Also:
    
    error(String)
  - partialGet
```
public static <K,V> (K) -> DataResult<V> partialGet((K) -> V partialGet,
                                                    by-name String errorPrefix)
```
    Converts a partial function into a function that produces a DataResult. If the partial function returns null, then the returned function returns an error DataResult, otherwise a successful DataResult.
    
    Type Parameters:
    
    K - The argument type of the partial function.
    
    V - The result type of the partial function.
    
    Parameters:
    
    partialGet - The partial function.
    
    errorPrefix - The error string to use if partialGet returns null.
    
    Returns:
    
    A function that wraps the result of the partial function in a DataResult.
    
    See Also:
    
    Optional
  - get
```
public (R|DataResult.PartialResult<R>) get()
```
    Returns the wrapped Either.
  - result
```
public Optional<R> result()
```
    Returns the successful result, if one is present.
    
    See Also:
    
    error()
  - lifecycle
```
public Lifecycle lifecycle()
```
    Returns the lifecycle used in this DataResult.
  - resultOrPartial
```
public Optional<R> resultOrPartial((String) -> void onError)
```
    Returns any result, if one is present. If this result is an error, the partial result, if any, is returned.
    
    Parameters:
    
    onError - A callback to run on error. It receives the error message.
    
    Returns:
    
    The result or partial result, if present.
  - getOrThrow
```
public R getOrThrow(boolean allowPartial,
                    (String) -> void onError)
```
    Unsafely gets the result stored in this DataResult.
    
    Parameters:
    
    allowPartial - Whether to return the partial result if this is an error.
    
    onError - A callback to run on error. It receives the error message.
    
    Returns:
    
    The result.
    
    Throws:
    
    RuntimeException - If this DataResult does not contain a result value.
  - error
```
public Optional<DataResult.PartialResult<R>> error()
```
    Returns the error DataResult.PartialResult, if one is present.
    
    See Also:
    
    result()
  - map
```
public <T> DataResult<T> map((? super R) -> ? extends T function)
```
    Applies a function to the result or partial result. Successes remain successes and errors remain errors.
    
    API Note:
    
    This method implements the functor operator for the type DataResult.
    
    Type Parameters:
    
    T - The new result type.
    
    Parameters:
    
    function - The conversion function.
    
    Returns:
    
    The converted result.
    
    See Also:
    
    flatMap(Function), ap(DataResult)
  - promotePartial
```
public DataResult<R> promotePartial((String) -> void onError)
```
    Promotes an error with a partial result to a success. If this is a success, it is returned unchanged.
    
    Parameters:
    
    onError - A callback to run on error. It is passed the error string.
    
    Returns:
    
    A success containing the result or partial result, or an error containing no result.
  - flatMap
```
public <R2> DataResult<R2> flatMap((? super R) -> ? extends DataResult<R2> function)
```
    Applies the function to either full or partial result, in case of partial concatenates errors.
    
    API Note:
    
    This method implements the monad operator in the context of DataResult.
    
    Type Parameters:
    
    R2 - The new result type.
    
    Parameters:
    
    function - The partial conversion function.
    
    Returns:
    
    The converted result.
    
    See Also:
    
    map(Function)
  - ap
```
public <R2> DataResult<R2> ap(DataResult<(R) -> R2> functionResult)
```
    Applies a function which is itself wrapped in a DataResult to the result or partial result.
    If either this or functionResult are errors, then the return value is also an error. Also, if either this or functionResult does not contain a result, then the return value also does not contain a result.
    
    API Note:
    
    This method implements the applicative operator in the context of DataResult.
    
    Type Parameters:
    
    R2 - The new result type.
    
    Parameters:
    
    functionResult - The function to potentially apply.
    
    Returns:
    
    The result of functionResult applies to this.
    
    See Also:
    
    map(Function), Applicative, Functors, Applicatives, and Monads
  - apply2
```
public <R2,S> DataResult<S> apply2((R,R2) -> S function,
                                   DataResult<R2> second)
```
    Combines this result with another result using the given function.
    
    API Note:
    
    This is an arity-2 specialization for map(Function).
    
    Type Parameters:
    
    R2 - The type of the second result value.
    
    S - The type of the output result value.
    
    Parameters:
    
    function - The function to apply to the wrapped values of this and the given result.
    
    second - The second DataResult value.
    
    Returns:
    
    A DataResult wrapping the application of the function to the provided results.
    
    See Also:
    
    map(Function)
  - apply2stable
```
public <R2,S> DataResult<S> apply2stable((R,R2) -> S function,
                                         DataResult<R2> second)
```
    Combines this result with another result using the given function, under the "stable" lifecycle.
    This method is equivalent to apply2(BiFunction, DataResult), except that the stable lifecycle is always used.
    
    Type Parameters:
    
    R2 - The type of the second result value.
    
    S - The type of the output result value.
    
    Parameters:
    
    function - The function to apply to the wrapped values of this and the given result.
    
    second - The second DataResult value.
    
    Returns:
    
    A DataResult wrapping the application of the function to the provided results.
    
    See Also:
    
    apply2(BiFunction, DataResult), map(Function)
  - apply3
```
public <R2,R3,S> DataResult<S> apply3((R,R2,R3) -> S function,
                                      DataResult<R2> second,
                                      DataResult<R3> third)
```
    Combines this result with two other results using the given function.
    
    API Note:
    
    This is an arity-3 specialization for map(Function).
    
    Type Parameters:
    
    R2 - The type of the second result value.
    
    R3 - The type of the third result value.
    
    S - The type of the output result value.
    
    Parameters:
    
    function - The function to apply to the wrapped values of this and the given results.
    
    second - The second DataResult value.
    
    third - The third DataResult value.
    
    Returns:
    
    A DataResult wrapping the application of the function to the provided results.
    
    See Also:
    
    map(Function)
  - setPartial
```
public DataResult<R> setPartial(by-name R partial)
```
    If this result is an error, replaces any partial result with the supplied partial result.
    
    Parameters:
    
    partial - A Supplier of partial results.
    
    Returns:
    
    A DataResult equivalent to this with the partial result set appropriately.
  - setPartial
```
public DataResult<R> setPartial(R partial)
```
    If this result is an error, replaces any partial result with the given partial result.
    
    Parameters:
    
    partial - A partial result.
    
    Returns:
    
    A DataResult equivalent to this with the partial result set appropriately.
  - mapError
```
public DataResult<R> mapError((String) -> String function)
```
    Applies the given function to the error message contained in this result.
    
    Parameters:
    
    function - The function to apply.
    
    Returns:
    
    A DataResult equivalent to this, but with any error message replaced.
  - setLifecycle
```
public DataResult<R> setLifecycle(Lifecycle lifecycle)
```
    Returns a DataResult with the same value as this result, but with the provided lifecycle.
  - addLifecycle
```
public DataResult<R> addLifecycle(Lifecycle lifecycle)
```
    Returns a DataResult with the same value as this result, but with the provided lifecycle added to this result's lifecycle.
    
    See Also:
    
    Lifecycle.add(Lifecycle)
  - instance
```
public static instance DataResult<_> instance()
```
    Returns the applicative type instance for the type DataResult.
    
    See Also:
    
    DataResult.Instance
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Returns a String describing this DataResult.
    
    Overrides:
    
    toString in class Object

Class DataResult<R>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

success

error

error

success

error

error

partialGet

get

result

lifecycle

resultOrPartial

getOrThrow

error

map

promotePartial

flatMap

ap

apply2

apply2stable

apply3

setPartial

setPartial

mapError

setLifecycle

addLifecycle

instance

equals

hashCode

toString