Interface DirectionRelativeDataProvider<V extends Value<E>,​E>

    • Method Detail

      • get

        default Optional<E> get​(DataHolder dataHolder)
        Description copied from interface: DataProvider
        Gets the elemental value from the provided DataHolder. This is generally considered the underlying implementation access for any ValueContainer.get(Key) where the Key is registered with this DataProvider. Nominally, this means the data is provided outside traditional serialized data that is stored with the DataHolder. It's possible that there may be changing return values for even immutable types, since the provider is providing the data.
        Specified by:
        get in interface DataProvider<V extends Value<E>,​E>
        Parameters:
        dataHolder - The data holder
        Returns:
        The value, if it's supported and exists
      • value

        default Optional<V> value​(DataHolder dataHolder)
        Description copied from interface: DataProvider
        Gets a constructed Value for the provided DataHolder. Much like DataProvider.get(DataHolder), this is generally considered the underlying implementation access for any ValueContainer.get(Key) where the Key is registered with this DataProvider. Nominally, this means the data is provided outside traditional serialized data that is stored with the DataHolder. It's possible that there may be changing return values for even immutable types, since the provider is providing the data.
        Specified by:
        value in interface DataProvider<V extends Value<E>,​E>
        Parameters:
        dataHolder - The data holder to get the constructed value from
        Returns:
        The value
      • isSupported

        default boolean isSupported​(DataHolder dataHolder)
        Description copied from interface: DataProvider
        Gets whether this value provider is supported by the given ValueContainer.
        Specified by:
        isSupported in interface DataProvider<V extends Value<E>,​E>
        Parameters:
        dataHolder - The data holder
        Returns:
        Whether it's supported
      • get

        Optional<E> get​(DataHolder dataHolder,
                        Direction direction)
        Gets the elemental value from the provided DataHolder. This is generally considered the underlying implementation access for any ValueContainer.get(Key) where the Key is registered with this DataProvider. Nominally, this means the data is provided outside traditional serialized data that is stored with the DataHolder. It's possible that there may be changing return values for even immutable types, since the provider is providing the data.
        Parameters:
        dataHolder - The data holder
        direction - The related relative direction to the data provider
        Returns:
        The value, if it's supported and exists
      • value

        default Optional<V> value​(DataHolder dataHolder,
                                  Direction direction)
        Gets a constructed Value for the provided DataHolder. Much like get(DataHolder), this is generally considered the underlying implementation access for any ValueContainer.get(Key) where the Key is registered with this DataProvider. Nominally, this means the data is provided outside traditional serialized data that is stored with the DataHolder. It's possible that there may be changing return values for even immutable types, since the provider is providing the data.
        Parameters:
        dataHolder - The data holder to get the constructed value from
        direction - The related relative direction to the data provider
        Returns:
        The value
      • isSupported

        boolean isSupported​(DataHolder dataHolder,
                            Direction direction)
        Gets whether this value provider is supported by the given ValueContainer.
        Parameters:
        dataHolder - The data holder
        direction - The related relative direction to the data provider
        Returns:
        Whether it's supported