Module dev.metaschema.databind
Package dev.metaschema.databind.codegen.config

Interface IChoiceGroupBindingConfiguration

All Known Implementing Classes:
DefaultChoiceGroupBindingConfiguration
public interface IChoiceGroupBindingConfiguration
Provides binding configuration for a choice group within an assembly definition.

Choice group bindings enable fine-grained control over code generation for choice groups, particularly for specifying custom collection types with type-safe item bounds.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getGroupAsName()
    Get the name of the choice group to match.
    String
    getItemTypeName()
    Get the fully qualified Java type name to use for collection items.
    boolean
    isUseWildcard()
    Determine whether to use a wildcard bounded type for the collection.

  • Method Details

    • getGroupAsName

      @NonNull String getGroupAsName()
      Get the name of the choice group to match.

      This name corresponds to the group-as name specified in the Metaschema module for the choice group.

      Returns:
      the choice group name

    • getItemTypeName

      @Nullable String getItemTypeName()
      Get the fully qualified Java type name to use for collection items.

      When specified, the generated field and getter will use this type instead of Object for the collection item type. This allows for type-safe collections when all choice alternatives share a common supertype.

      Returns:
      the fully qualified Java type name, or null if not specified

    • isUseWildcard

      boolean isUseWildcard()
      Determine whether to use a wildcard bounded type for the collection.

      When true, generates List<? extends Type> instead of List<Type>. This provides additional flexibility when the exact item type may vary while still maintaining type safety.

      Defaults to true if an item type is specified.

      Returns:
      true to use wildcard bounds, false otherwise