Package org.spongepowered.api.util

Interface Updater<C>

Type Parameters:
C - The type of object being updated
All Known Subinterfaces:
DataContentUpdater
public interface Updater<C>
An updater that will take a type and update it across different versions. Whether this is applicable to serialization or object management is not required.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    inputVersion()
    Gets the numerical version that this Updater can accept.
    int
    outputVersion()
    The outputted version that this Updater will output to.
    C
    update(C content)
    Attempts to update the content of C as long as the content version itself has been abided by.

  • Method Details

    • inputVersion

      int inputVersion()
      Gets the numerical version that this Updater can accept.
      Returns:
      The numerical input version

    • outputVersion

      int outputVersion()
      The outputted version that this Updater will output to. Note that it is possible multiple updaters are able to cross between different versions.
      Returns:
      The numerical output version

    • update

      C update(C content)
      Attempts to update the content of C as long as the content version itself has been abided by.
      Parameters:
      content - The content to update
      Returns:
      The updated content