org.keycloak.models.utils

## Class FormMessage

- java.lang.Object
- - org.keycloak.models.utils.FormMessage

-     public class FormMessage
      extends Object

  Message (eg. error) to be shown in form.
  Author:
    Vlastimil Elias (velias at redhat dot com)

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `GLOBAL` Value used for `field` if message is global (not tied to any specific form field)

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `FormMessage()`
    `FormMessage(String message, Object... parameters)`
    `FormMessage(String field, String message)` Create message without parameters.
    `FormMessage(String field, String message, Object... parameters)` Create message.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getField()`
    `String` | `getMessage()`
    `Object[]` | `getParameters()`
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### GLOBAL

          public static final String GLOBAL

      Value used for `field` if message is global (not tied to any specific form field)
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### FormMessage

          public FormMessage()

    - #### FormMessage

          public FormMessage(String field,
                             String message,
                             Object... parameters)

      Create message.
      Parameters:
        `field` - this message is for. `GLOBAL` is used if null
        `message` - key for the message
        `parameters` - to be formatted into message

    - #### FormMessage

          public FormMessage(String message,
                             Object... parameters)

    - #### FormMessage

          public FormMessage(String field,
                             String message)

      Create message without parameters.
      Parameters:
        `field` - this message is for. `GLOBAL` is used if null
        `message` - key for the message

  - ### Method Detail

    - #### getField

          public String getField()

    - #### getMessage

          public String getMessage()

    - #### getParameters

          public Object[] getParameters()

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

Copyright © 2021 JBoss by Red Hat. All rights reserved.