Package dev.prozilla.pine.common.property

Interface FloatProperty

All Superinterfaces:
Functor<Float>, NonNullProperty<Float>, Property<Float>
All Known Subinterfaces:
MutableFloatProperty, ObservableFloatProperty
All Known Implementing Classes:
AdaptiveFloatProperty, AnimatedFloatProperty, DeserializedFloatProperty, FixedFloatProperty, FloatConfigOption, LocalRandomFloatProperty, RandomFloatProperty, SimpleMutableFloatProperty, SimpleObservableFloatProperty, StoredFloatProperty, TransitionedFloatProperty
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface FloatProperty extends NonNullProperty<Float>
A property with a float value.

  • Method Details

    • getValueOr

      default Float getValueOr(Float defaultValue)
      Description copied from interface: Property
      Returns the value of this property, or defaultValue if the value is null.
      Specified by:
      getValueOr in interface Property<Float>
      Parameters:
      defaultValue - The default value to use
      Returns:
      The value of this property, or defaultValue if the value is null.

    • requireValue

      @NotNull default @NotNull Float requireValue()
      Description copied from interface: Property
      Returns the value of this property, if it is not null, otherwise throws an exception.
      Specified by:
      requireValue in interface Property<Float>
      Returns:
      The value of this property

    • getValue

      default Float getValue()
      Description copied from interface: Property
      Returns the value of this property.
      Specified by:
      getValue in interface Property<Float>
      Returns:
      The value of this property.

    • get

      float get()
      Returns the primitive value of this property.
      Returns:
      The primitive value of this property.

    • has

      default boolean has(float value)

    • replaceNull

      @Contract("_ -> this") default FloatProperty replaceNull(Float defaultValue)
      Description copied from interface: NonNullProperty
      Returns this property, whose value is never null.
      Specified by:
      replaceNull in interface NonNullProperty<Float>
      Specified by:
      replaceNull in interface Property<Float>
      Returns:
      This property.

    • map

      default FloatProperty map(FloatMapper mapper)

    • isZeroProperty

      default BooleanProperty isZeroProperty()
      Returns a boolean property whose value is true if the value of this property is 0.
      Returns:
      A boolean property based on whether the value of this property is 0.
      See Also:

    • hasProperty

      default BooleanProperty hasProperty(float value)
      Returns a boolean property whose value is true if the value of this property is equal to value.
      Returns:
      A boolean property whose value is true if the value of this property is equal to value.
      See Also:

    • fromProperty

      static FloatProperty fromProperty(FloatProperty property)

    • fromProperty

      @Contract("_ -> new") static FloatProperty fromProperty(Property<Float> property)

    • getValueOf

      @Contract("null, _ -> param2") static float getValueOf(FloatProperty property, float defaultValue)
      Returns the value of a given property, or a default value if the property is null.
      Parameters:
      property - The property or null
      defaultValue - The value to use in case the property is null.
      Returns:
      The value