org.valkyriercp.rules.constraint.Required Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of valkyrie-rcp-core Show documentation
There is a newer version: 1.3
package org.valkyriercp.rules.constraint;

import org.springframework.util.StringUtils;
import org.valkyriercp.rules.reporting.TypeResolvable;

import java.util.Collection;
import java.util.Map;

/**
 * Validates a required property. Required is defined as non-null and, if the
 * object is a string, not empty and not blank. If the object is an instance of
 * {@link java.util.Collection}, {@link java.util.Map} or an array it will test if it is empty.
 *
 * @author Keith Donald
 * @author Mathias Broekelmann
 */
public class Required implements Constraint, TypeResolvable {
	private static final Required required = new Required();

	private static final Required present = new Required("present");

	private final String type;

	/**
	 * Creates a required constraint by using a custom type. This is primarly
	 * used to separate required and present constraint. These constraints where
	 * equaly implemented but where used differently
	 *
	 * @param type the type of the constraint. see {@link #getType()}
	 */
	public Required(String type) {
		this.type = type;
	}

	/**
	 * Default constructor which creates a required constraint by using the type
	 * required
	 */
	public Required() {
		this("required");
	}

	/**
	 * Tests if this argument is present (non-null, not-empty, not blank)
	 *
	 * @see Constraint#test(java.lang.Object)
	 */
	public boolean test(Object argument) {
		if (argument != null) {
			if (argument instanceof String) {
				if (StringUtils.hasText((String) argument)) {
					return true;
				}
			}
			else if (argument instanceof Collection) {
				return !((Collection) argument).isEmpty();
			}
			else if (argument instanceof Map) {
				return !((Map) argument).isEmpty();
			}
			else if (argument.getClass().isArray()) {
				return ((Object[]) argument).length > 0;
			}
			else {
				return true;
			}
		}
		return false;
	}

	/**
	 * returns the required instance
	 *
	 * @return the required instance (never null)
	 */
	public static Required instance() {
		return required;
	}

	/**
	 * returns the present instance
	 *
	 * @return the present instance (never null)
	 */
	public static Required present() {
		return present;
	}

	public String toString() {
		return getType();
	}

	public String getType() {
		return type;
	}
}