Package com.adobe.granite.haf.annotations

Annotation Type ApiSyntheticModel

@Target(TYPE) @Retention(RUNTIME) public @interface ApiSyntheticModel
This annotation marks a model as synthetic. Meaning it is able to model a synthetic resource which does not correspond to a node that exists in the repository.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Class<?>[]
    parentmodel
    A list of parent models that can "own" this synthetic model.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    segmentPattern
    The path segment used to locate this synthetic model.

  • Element Details

    • parentmodel

      Class<?>[] parentmodel
      A list of parent models that can "own" this synthetic model. These can themselves also be synthetic models.
      Returns:
      a list of classes that point the implementation of the parent model.

    • segmentPattern

      String segmentPattern
      The path segment used to locate this synthetic model. This string can be a regular expression to allow flexibility in registering many synthetic models under a parent model.
      Returns:
      a string which will be used as a regular expression to match the path segment. If the value is empty it will match all segments.
      Default:
      ""