Package com.adobe.granite.haf.converter.api.description

Interface PropertyDescription

@ProviderType public interface PropertyDescription
A description of a property defined in the model.

  • Method Details

    • getName

      @Nonnull String getName()
      Get the name of the property.
      Returns:
      The name of the property.

    • getValue

      @CheckForNull Object getValue()
      Get the value of the property.
      Returns:
      The property value.

    • getScope

      @Nonnull ApiProperty.SCOPE getScope()
      The scope of the property. The scope can be used to decide when to serialize the property. Whether it is serialized for a main entity, a child entity or both.
      Returns:
      The property's scope.