com.mitchellbosecke.pebble.spring.extension.function.bindingresult.GetFieldErrorsFunction Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2013 by Mitchell Bösecke
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
package com.mitchellbosecke.pebble.spring.extension.function.bindingresult;

import com.mitchellbosecke.pebble.template.EvaluationContext;
import com.mitchellbosecke.pebble.template.PebbleTemplate;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import org.springframework.context.MessageSource;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;

/**
 * 
 * Function available to templates in Spring MVC applications in order to access the BindingResult
 * of a form
 * 
 *
 * @author Eric Bussieres
 */
public class GetFieldErrorsFunction extends BaseBindingResultFunction {

  public static final String FUNCTION_NAME = "getFieldErrors";

  private final MessageSource messageSource;

  public GetFieldErrorsFunction(MessageSource messageSource) {
    super(PARAM_FORM_NAME, PARAM_FIELD_NAME);
    this.messageSource = messageSource;
  }

  @Override
  public Object execute(Map args, PebbleTemplate self, EvaluationContext context,
      int lineNumber) {
    String formName = (String) args.get(PARAM_FORM_NAME);
    String field = (String) args.get(PARAM_FIELD_NAME);

    if (field == null) {
      throw new IllegalArgumentException("Field parameter is required in GetFieldErrorsFunction");
    }

    Locale locale = context.getLocale();
    BindingResult bindingResult = this.getBindingResult(formName, context);

    return this.constructErrorMessages(field, locale, bindingResult);
  }

  private List constructErrorMessages(String field, Locale locale,
      BindingResult bindingResult) {
    List errorMessages = new ArrayList<>();
    if (bindingResult != null) {
      for (FieldError error : bindingResult.getFieldErrors(field)) {
        String msg = this.messageSource.getMessage(error, locale);
        errorMessages.add(msg);
      }
    }
    return errorMessages;
  }
}