org.hibernate.validator.engine.ValueContext Maven / Gradle / Ivy

Go to download
// $Id$
/*
* JBoss, Home of Professional Open Source
* Copyright 2009, Red Hat, Inc. and/or its affiliates, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* 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
* http://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.hibernate.validator.engine;

import java.lang.annotation.ElementType;
import javax.validation.groups.Default;

/**
 * An instance of this class is used to collect all the relevant information for validating a single entity/bean.
 *
 * @author Hardy Ferentschik
 */
public class ValueContext {

	/**
	 * The current bean which gets validated. This is the bean hosting the constraints which get validated.
	 */
	private final T currentBean;

	/**
	 * The class of the current bean.
	 */
	private final Class currentBeanType;

	/**
	 * The current property path we are validating.
	 */
	private PathImpl propertyPath;

	/**
	 * The current group we are validating.
	 */
	private Class currentGroup;

	/**
	 * The value which gets currently evaluated.
	 */
	private V currentValue;

	/**
	 * The {@code ElementType} the constraint was defined on
	 */
	private ElementType elementType;

	public static  ValueContext getLocalExecutionContext(T value) {
		@SuppressWarnings("unchecked")
		Class rootBeanClass = ( Class ) value.getClass();
		return new ValueContext( value, rootBeanClass );
	}

	public static  ValueContext getLocalExecutionContext(Class type) {
		return new ValueContext( null, type );
	}

	public ValueContext(T currentBean, Class currentBeanType) {
		this.currentBean = currentBean;
		this.currentBeanType = currentBeanType;
	}

	public PathImpl getPropertyPath() {
		return propertyPath;
	}

	public Class getCurrentGroup() {
		return currentGroup;
	}

	public T getCurrentBean() {
		return currentBean;
	}

	public Class getCurrentBeanType() {
		return currentBeanType;
	}

	public V getCurrentValidatedValue() {
		return currentValue;
	}

	public void setPropertyPath(PathImpl propertyPath) {
		this.propertyPath = propertyPath;
	}

	public void setCurrentGroup(Class currentGroup) {
		this.currentGroup = currentGroup;
	}

	public void setCurrentValidatedValue(V currentValue) {
		this.currentValue = currentValue;
	}

	public void markCurrentPropertyAsIterable() {
		propertyPath.getLeafNode().setInIterable( true );
	}

	public boolean validatingDefault() {
		return getCurrentGroup() != null && getCurrentGroup().getName().equals( Default.class.getName() );
	}

	public ElementType getElementType() {
		return elementType;
	}

	public void setElementType(ElementType elementType) {
		this.elementType = elementType;
	}

	@Override
	public String toString() {
		final StringBuilder sb = new StringBuilder();
		sb.append( "ValueContext" );
		sb.append( "{currentBean=" ).append( currentBean );
		sb.append( ", currentBeanType=" ).append( currentBeanType );
		sb.append( ", propertyPath=" ).append( propertyPath );
		sb.append( ", currentGroup=" ).append( currentGroup );
		sb.append( ", currentValue=" ).append( currentValue );
		sb.append( ", elementType=" ).append( elementType );
		sb.append( '}' );
		return sb.toString();
	}
}