Package custom_jfx_plugin.property

Interface Property<T>

All Known Subinterfaces:
ObservableProperty<T>
public interface Property<T>

  • Method Summary

    Modifier and Type
    Method
    Description
    static <T> @NotNull Property<T>
    create()
    Generate new instance of property without initial value
    static <T> @NotNull Property<T>
    create(T initial)
    Generate new instance of property with initial value
    T
    get()
    Returns the property values
    default T
    getOrElse(@NotNull org.gradle.api.provider.Provider<T> provider)
    Returns the property value, or it's replaced with a default valid content
    default T
    getOrElse(T defaultValue)
    Returns the property value, or it's replaced with a default valid content
    default T
    getOrElseThrow()
    Returns the property value, or throws an error if is not defined
    default T
    getOrElseThrow(@NotNull String name)
    Returns the property value, or throws an error if is not defined
    default boolean
    isNotPresent()
    Check if the property contains a valid not null value
    default boolean
    isPresent()
    Check if the property contains a valid not null value
    default void
    set(@NotNull org.gradle.api.provider.Provider<T> provider)
    Change the property value
    void
    set(T newValue)
    Change the property value

  • Method Details

    • get

      @Nullable T get()
      Returns the property values
      Returns:
      the property value or null if value is not declared

    • set

      void set(@Nullable T newValue)
      Change the property value
      Parameters:
      newValue - the new property value

    • set

      default void set(@NotNull @NotNull org.gradle.api.provider.Provider<T> provider)
      Change the property value
      Parameters:
      provider - the object provider

    • isPresent

      default boolean isPresent()
      Check if the property contains a valid not null value
      Returns:
      true if the value is valid or false otherwise

    • isNotPresent

      default boolean isNotPresent()
      Check if the property contains a valid not null value
      Returns:
      true if the value is null or is not defined or false otherwise

    • getOrElse

      @NotNull default T getOrElse(@NotNull T defaultValue)
      Returns the property value, or it's replaced with a default valid content
      Parameters:
      defaultValue - the valid value if the content value is not valid
      Returns:
      the valid value

    • getOrElse

      @NotNull default T getOrElse(@NotNull @NotNull org.gradle.api.provider.Provider<T> provider)
      Returns the property value, or it's replaced with a default valid content
      Parameters:
      provider - the valid value if the content value is not valid
      Returns:
      the valid value

    • getOrElseThrow

      @NotNull default T getOrElseThrow()
      Returns the property value, or throws an error if is not defined
      Returns:
      the valid value

    • getOrElseThrow

      @NotNull default T getOrElseThrow(@NotNull @NotNull String name)
      Returns the property value, or throws an error if is not defined
      Parameters:
      name - property name
      Returns:
      the valid value

    • create

      @Contract(" -> new") @NotNull static <T> @NotNull Property<T> create()
      Generate new instance of property without initial value
      Type Parameters:
      T - property type value
      Returns:
      property instance

    • create

      @NotNull static <T> @NotNull Property<T> create(@Nullable T initial)
      Generate new instance of property with initial value
      Type Parameters:
      T - property type value
      Returns:
      property instance