com.mojang.serialization

Class Lifecycle

java.lang.Object

com.mojang.serialization.Lifecycle

Direct Known Subclasses:

Lifecycle.Deprecated

public class Lifecycle
extends Object

A marker defining the stability of a given result. Experimental results are may changed incompatibly in the future and deprecated results may be removed in the future.

See Also:

Codec.withLifecycle(Lifecycle), DataResult.setLifecycle(Lifecycle)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Lifecycle.Deprecated A class for deprecated lifecycles.

Method Summary

Modifier and Type	Method and Description
Lifecycle	add(Lifecycle other) Combines this lifecycle with another lifecycle.
static Lifecycle	deprecated(int since) Returns a deprecated lifecycle for the given version.
static Lifecycle	experimental() Returns the experimental lifecycle.
static Lifecycle	stable() Returns the stable lifecycle.

Methods inherited from class java.lang.Object

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

Method Detail

experimental

public static Lifecycle experimental()

Returns the experimental lifecycle.

stable

public static Lifecycle stable()

Returns the stable lifecycle.

deprecated

public static Lifecycle deprecated(int since)

Returns a deprecated lifecycle for the given version.

Parameters:

since - The version the lifecycle is for.

See Also:

Lifecycle.Deprecated

add

public Lifecycle add(Lifecycle other)

Combines this lifecycle with another lifecycle. The lifecycle with the highest potential for breakage (either this or other) is returned.

For example, the following lifecycles are ordered according to breakage potential.

1. Experimental
2. Deprecated(since = 1)
3. Deprecated(since = 2)
4. Stable

Parameters:

other - The lifecycle to compare this lifecycle against.

Returns:

The lifecycle with the highest "breakage potential".