Package io.micronaut.views.fields

Interface FormGenerator

All Known Implementing Classes:
DefaultFormGenerator
public interface FormGenerator
Generates a Form for a given type representing a form class.
Since:
4.1.0
Author:
Sergio del Amo

  • Field Details

  • Method Details

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Object instance)
      Parameters:
      action - Form action attribute
      method - Form method attribute
      instance - The Object instance which should be Introspected.
      Returns:
      A Form

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Object instance)
      Generate FORM Post.
      Parameters:
      action - Form action attribute
      instance - The Object instance which should be Introspected.
      Returns:
      A Form

    • generateWithFieldset

      @NonNull @NonNull Form generateWithFieldset(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Fieldset fieldset, @NonNull @NonNull InputSubmitFormElement inputSubmitFormElement)
      Generate FORM with fieldset.
      Parameters:
      action - Form action attribute
      method - Form method attribute
      fieldset - Fieldset
      inputSubmitFormElement - input submit
      Returns:
      A Form

    • generateWithFieldset

      @NonNull default @NonNull Form generateWithFieldset(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Fieldset fieldset, @NonNull @NonNull Message submitValue)
      Generate FORM with fieldset.
      Parameters:
      action - Form action attribute
      method - Form method attribute
      fieldset - Fieldset
      submitValue - input submit
      Returns:
      A Form

    • generateWithFieldset

      @NonNull default @NonNull Form generateWithFieldset(@NonNull @NonNull String action, @NonNull @NonNull Fieldset fieldset, @NonNull @NonNull Message submitValue)
      Generate Form with fieldset.
      Parameters:
      action - Form action attribute
      fieldset - Fieldset
      submitValue - input submit
      Returns:
      A Form

    • generateWithFieldset

      @NonNull default @NonNull Form generateWithFieldset(@NonNull @NonNull String action, @NonNull @NonNull Fieldset fieldset)
      Generate Form with fieldset.
      Parameters:
      action - Form action attribute
      fieldset - Fieldset
      Returns:
      A Form

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Object instance, @NonNull @NonNull Message submitValue)
      Parameters:
      action - Form action attribute
      method - Form method attribute
      instance - The Object instance which should be Introspected.
      submitValue - input submit
      Returns:
      A Form

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Object instance, @NonNull @NonNull Message submitValue)
      Generate FORM Post.
      Parameters:
      action - Form action attribute
      instance - The Object instance which should be Introspected.
      submitValue - input submit
      Returns:
      A Form

    • generate

      @NonNull @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Object instance, @NonNull @NonNull InputSubmitFormElement inputSubmitFormElement)
      Parameters:
      action - Form action attribute
      method - Form method attribute
      instance - The Object instance which should be Introspected.
      inputSubmitFormElement - input submit
      Returns:
      A Form

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Object instance, @NonNull @NonNull InputSubmitFormElement inputSubmitFormElement)
      Generate FORM Post.
      Parameters:
      action - Form action attribute
      instance - The Object instance which should be Introspected.
      inputSubmitFormElement - input submit
      Returns:
      A Form

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Object instance, @NonNull @NonNull jakarta.validation.ConstraintViolationException ex)
      Parameters:
      action - Form action attribute
      method - Form method attribute
      instance - The Object instance which should be Introspected.
      ex - A Validation exception
      Returns:
      A Form

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Object instance, @NonNull @NonNull jakarta.validation.ConstraintViolationException ex)
      Generate POST form.
      Parameters:
      action - Form action attribute
      instance - The Object instance which should be Introspected.
      ex - A Validation exception
      Returns:
      A Form

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Object instance, @NonNull @NonNull jakarta.validation.ConstraintViolationException ex, @NonNull @NonNull Message submitValue)
      Parameters:
      action - Form action attribute
      method - Form method attribute
      instance - The Object instance which should be Introspected.
      ex - A Validation exception
      submitValue - input submit
      Returns:
      A Form

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Object instance, @NonNull @NonNull jakarta.validation.ConstraintViolationException ex, @NonNull @NonNull Message submitValue)
      Generate POST form.
      Parameters:
      action - Form action attribute
      instance - The Object instance which should be Introspected.
      ex - A Validation exception
      submitValue - input submit
      Returns:
      A Form

    • generate

      @NonNull @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Object instance, @NonNull @NonNull jakarta.validation.ConstraintViolationException ex, @NonNull @NonNull InputSubmitFormElement inputSubmitFormElement)
      Parameters:
      action - Form action attribute
      method - Form method attribute
      instance - The Object instance which should be Introspected.
      ex - A Validation exception
      inputSubmitFormElement - input submit
      Returns:
      A Form

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Object instance, @NonNull @NonNull jakarta.validation.ConstraintViolationException ex, @NonNull @NonNull InputSubmitFormElement inputSubmitFormElement)
      Generate POST form.
      Parameters:
      action - Form action attribute
      instance - The Object instance which should be Introspected.
      ex - A Validation exception
      inputSubmitFormElement - input submit
      Returns:
      A Form

    • generate

      @NonNull default <T> @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Class<T> type)
      Type Parameters:
      T - type
      Parameters:
      action - Form action attribute
      method - Form method attribute
      type - A class which should be Introspected.
      Returns:
      A Form

    • generate

      @NonNull default <T> @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Class<T> type)
      Generate POST Form.
      Type Parameters:
      T - type
      Parameters:
      action - Form action attribute
      type - A class which should be Introspected.
      Returns:
      A Form

    • generate

      @NonNull default <T> @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Class<T> type, @NonNull @NonNull Message submitValue)
      Type Parameters:
      T - type
      Parameters:
      action - Form action attribute
      method - Form method attribute
      type - A class which should be Introspected.
      submitValue - input submit
      Returns:
      A Form

    • generate

      @NonNull default <T> @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Class<T> type, @NonNull @NonNull Message submitValue)
      Generate a POST Form.
      Type Parameters:
      T - type
      Parameters:
      action - Form action attribute
      type - A class which should be Introspected.
      submitValue - input submit
      Returns:
      A Form

    • generate

      @NonNull <T> @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Class<T> type, @NonNull @NonNull InputSubmitFormElement inputSubmitFormElement)
      Type Parameters:
      T - type
      Parameters:
      action - Form action attribute
      method - Form method attribute
      type - A class which should be Introspected.
      inputSubmitFormElement - input submit
      Returns:
      A Form

    • generate

      @NonNull default <T> @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Class<T> type, @NonNull @NonNull InputSubmitFormElement inputSubmitFormElement)
      Generate a POST form.
      Type Parameters:
      T - type
      Parameters:
      action - Form action attribute
      type - A class which should be Introspected.
      inputSubmitFormElement - input submit
      Returns:
      A Form

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Object instance, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Parameters:
      action - Form action attribute
      method - Form method attribute
      instance - The Object instance which should be Introspected.
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Object instance, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Generate FORM Post.
      Parameters:
      action - Form action attribute
      instance - The Object instance which should be Introspected.
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Object instance, @NonNull @NonNull Message submitValue, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Parameters:
      action - Form action attribute
      method - Form method attribute
      instance - The Object instance which should be Introspected.
      submitValue - input submit
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Object instance, @NonNull @NonNull Message submitValue, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Generate FORM Post.
      Parameters:
      action - Form action attribute
      instance - The Object instance which should be Introspected.
      submitValue - input submit
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Object instance, @NonNull @NonNull InputSubmitFormElement inputSubmitFormElement, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Parameters:
      action - Form action attribute
      method - Form method attribute
      instance - The Object instance which should be Introspected.
      inputSubmitFormElement - input submit
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Object instance, @NonNull @NonNull InputSubmitFormElement inputSubmitFormElement, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Generate FORM Post.
      Parameters:
      action - Form action attribute
      instance - The Object instance which should be Introspected.
      inputSubmitFormElement - input submit
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Object instance, @NonNull @NonNull jakarta.validation.ConstraintViolationException ex, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Parameters:
      action - Form action attribute
      method - Form method attribute
      instance - The Object instance which should be Introspected.
      ex - A Validation exception
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Object instance, @NonNull @NonNull jakarta.validation.ConstraintViolationException ex, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Generate POST form.
      Parameters:
      action - Form action attribute
      instance - The Object instance which should be Introspected.
      ex - A Validation exception
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Object instance, @NonNull @NonNull jakarta.validation.ConstraintViolationException ex, @NonNull @NonNull Message submitValue, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Parameters:
      action - Form action attribute
      method - Form method attribute
      instance - The Object instance which should be Introspected.
      ex - A Validation exception
      submitValue - input submit
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Object instance, @NonNull @NonNull jakarta.validation.ConstraintViolationException ex, @NonNull @NonNull Message submitValue, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Generate POST form.
      Parameters:
      action - Form action attribute
      instance - The Object instance which should be Introspected.
      ex - A Validation exception
      submitValue - input submit
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Object instance, @NonNull @NonNull jakarta.validation.ConstraintViolationException ex, @NonNull @NonNull InputSubmitFormElement inputSubmitFormElement, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Parameters:
      action - Form action attribute
      method - Form method attribute
      instance - The Object instance which should be Introspected.
      ex - A Validation exception
      inputSubmitFormElement - input submit
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Object instance, @NonNull @NonNull jakarta.validation.ConstraintViolationException ex, @NonNull @NonNull InputSubmitFormElement inputSubmitFormElement, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Generate POST form.
      Parameters:
      action - Form action attribute
      instance - The Object instance which should be Introspected.
      ex - A Validation exception
      inputSubmitFormElement - input submit
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default <T> @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Class<T> type, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Type Parameters:
      T - type
      Parameters:
      action - Form action attribute
      method - Form method attribute
      type - A class which should be Introspected.
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default <T> @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Class<T> type, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Generate POST Form.
      Type Parameters:
      T - type
      Parameters:
      action - Form action attribute
      type - A class which should be Introspected.
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default <T> @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Class<T> type, @NonNull @NonNull Message submitValue, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Type Parameters:
      T - type
      Parameters:
      action - Form action attribute
      method - Form method attribute
      type - A class which should be Introspected.
      submitValue - input submit
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default <T> @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Class<T> type, @NonNull @NonNull Message submitValue, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Generate a POST Form.
      Type Parameters:
      T - type
      Parameters:
      action - Form action attribute
      type - A class which should be Introspected.
      submitValue - input submit
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull <T> @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull String method, @NonNull @NonNull Class<T> type, @NonNull @NonNull InputSubmitFormElement inputSubmitFormElement, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Type Parameters:
      T - type
      Parameters:
      action - Form action attribute
      method - Form method attribute
      type - A class which should be Introspected.
      inputSubmitFormElement - input submit
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0

    • generate

      @NonNull default <T> @NonNull Form generate(@NonNull @NonNull String action, @NonNull @NonNull Class<T> type, @NonNull @NonNull InputSubmitFormElement inputSubmitFormElement, @NonNull @NonNull BiConsumer<String,io.micronaut.core.beans.BeanIntrospection.Builder<? extends FormElement>> builderConsumer)
      Generate a POST form.
      Type Parameters:
      T - type
      Parameters:
      action - Form action attribute
      type - A class which should be Introspected.
      inputSubmitFormElement - input submit
      builderConsumer - A BiConsumer with the property name and the builder. It allows to consume a form element builder while the form fieldset is being generated.
      Returns:
      A Form
      Since:
      5.1.0