Interface SpecificProperty<T>

public interface SpecificProperty<T>

Specific (custom) API per library

Propane generates a custom "specific" API for each library using it. Part of this custom API layer is an own "property type" called the libraries specific property type.

This interface is the foundation of this specific property type, which is nothing more than a wrapper around this, like:

public interface JDACProperty<T> extends SpecificProperty<T> {
    ...
}

If you're working with propane or a library using propane, you will mostly see and use the libraries specific property type (like JDACProperty, JDACIntrospection etc.). Types, that have their "specific" version generated, are marked by the @Skeleton annotations. These types shouldn't be used directly but their specific version like JDACProperty.

Getting the "real" property

This interface doesn't extend Property, thus enabling Property to be sealed and allows the java compiler to check pattern exhaustiveness, which makes working with it easy.

A libraries specific property type must only be implemented by its specific MappingPropertySkeleton, SingletonPropertySkeleton and EnumerationPropertySkeleton, which themselves implement Property. Therefore, a libraries specific property type can always be safely cast to Property.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Property<T>
    generalized()
    Casts this specific property type to Property.
    default T
    scopedGet()
    Shortcut for generalized().getScoped()

  • Method Details

    • generalized

      default Property<T> generalized()
      Casts this specific property type to Property. This cast method is safe as guaranteed by the spec.
      Returns:
      this as a Property

    • scopedGet

      default T scopedGet()
      Shortcut for generalized().getScoped()
      Returns:
      the value for this property based on the current scope
      See Also: