org.omnifaces.component.validator.ValidateAll Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of omnifaces Show documentation

Jakarta Faces 3.0+ utility library

There is a newer version: 4.4.1

/*
 * Copyright OmniFaces
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
package org.omnifaces.component.validator;

import static org.omnifaces.util.Utils.isEmpty;

import java.util.List;

import jakarta.faces.component.FacesComponent;
import jakarta.faces.component.UIInput;
import jakarta.faces.context.FacesContext;

import org.omnifaces.validator.MultiFieldValidator;

/**
 * 
 * The <o:validateAll> validates if ALL of the given {@link UIInput} components have been filled out.
 * One could of course also just put required="true" on all of those {@link UIInput} components, but
 * sometimes it's desireable to invalidate all of those fields and/or to have just only one message for it, which isn't
 * possible with the standard Faces API.
 * 

 * The default message is
 * 
{0}: Please fill out all of those fields
 * 
 * For general usage instructions, refer {@link ValidateMultipleFields} documentation.
 *
 * @author Bauke Scholtz
 * @since 1.1
 * @see ValidateMultipleFields
 * @see ValidatorFamily
 * @see MultiFieldValidator
 */
@FacesComponent(ValidateAll.COMPONENT_TYPE)
public class ValidateAll extends ValidateMultipleFields {

	// Public constants -----------------------------------------------------------------------------------------------

	/** The component type, which is {@value org.omnifaces.component.validator.ValidateAll#COMPONENT_TYPE}. */
	public static final String COMPONENT_TYPE = "org.omnifaces.component.validator.ValidateAll";

	// Actions --------------------------------------------------------------------------------------------------------

	/**
	 * Validate if all is filled out.
	 */
	@Override
	public boolean validateValues(FacesContext context, List inputs, List