Coverage Report - org.apache.tapestry.form.ValidationMessages
 
Classes in this File Line Coverage Branch Coverage Complexity
ValidationMessages
N/A
N/A
1
 
 1  
 // Copyright 2005 The Apache Software Foundation
 2  
 //
 3  
 // Licensed under the Apache License, Version 2.0 (the "License");
 4  
 // you may not use this file except in compliance with the License.
 5  
 // You may obtain a copy of the License at
 6  
 //
 7  
 //     http://www.apache.org/licenses/LICENSE-2.0
 8  
 //
 9  
 // Unless required by applicable law or agreed to in writing, software
 10  
 // distributed under the License is distributed on an "AS IS" BASIS,
 11  
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12  
 // See the License for the specific language governing permissions and
 13  
 // limitations under the License.
 14  
 
 15  
 package org.apache.tapestry.form;
 16  
 
 17  
 import java.util.Locale;
 18  
 
 19  
 /**
 20  
  * Support interface used to provide access to validation messages. Typically used by
 21  
  * {@link org.apache.tapestry.form.validator.Validator}s.
 22  
  * 
 23  
  * @author Howard Lewis Ship
 24  
  * @since 4.0
 25  
  */
 26  
 public interface ValidationMessages
 27  
 {
 28  
     /**
 29  
      * Formats a validation message. Automatically chooses the correct localization.
 30  
      * 
 31  
      * @param messageOverride
 32  
      *            a supplied override to the default message format taken from the
 33  
      *            ValidationStrings.properties message catalog.
 34  
      * @param messageKey
 35  
      *            used to look up the message format when messageOverride is blank (null or empty)
 36  
      * @param arguments
 37  
      *            array of arguments formatted with the message format
 38  
      */
 39  
 
 40  
     String formatValidationMessage(String messageOverride, String messageKey,
 41  
             Object[] arguments);
 42  
 
 43  
     /**
 44  
      * Returns the locale for which messages are generated.
 45  
      */
 46  
 
 47  
     Locale getLocale();
 48  
 }