DetailedConstraintViolationException.java

/*
 * Copyright 2019 Global Crop Diversity Trust
 *
 * 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.gringlobal.api.exception;

import java.util.Set;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;

/**
 * @author Maxym Borodenko
 */
public class DetailedConstraintViolationException extends ConstraintViolationException {

	private static final long serialVersionUID = 1L;

	/**
	 * Creates a constraint violation report.
	 *
	 * @param message error message
	 * @param constraintViolations {@code Set} of {@link ConstraintViolation}
	 */
	public DetailedConstraintViolationException(final String message, final Set<? extends ConstraintViolation<?>> constraintViolations) {
		super(message, constraintViolations);
	}

	/**
	 * Creates a constraint violation report.
	 *
	 * @param constraintViolations {@code Set} of {@link ConstraintViolation}
	 */
	public DetailedConstraintViolationException(final Set<? extends ConstraintViolation<?>> constraintViolations) {
		this(null, constraintViolations);
	}

	/**
	 * Instantiates from existing ConstraintViolationException instance.
	 *
	 * @param ex the ConstraintViolationException instance
	 */
	public DetailedConstraintViolationException(final ConstraintViolationException ex) {
		this(ex.getMessage(), ex.getConstraintViolations());
	}

	/**
	 * Make readable error message from the set of constraint violations reported
	 * during a validation.
	 *
	 * @return error message
	 */
	@Override
	public String getMessage() {
		if (super.getMessage() != null) {
			return super.getMessage();
		}

		final StringBuilder message = new StringBuilder("Validation failed: ");
		if (super.getConstraintViolations() != null) {
			for (final ConstraintViolation<?> cv : super.getConstraintViolations()) {
				String[] pathParts = cv.getPropertyPath().toString().split("\\.");
				String prop = pathParts[pathParts.length - 1];
				message.append(prop);
				message.append(" -> ");
				message.append(cv.getMessage());
				message.append("; ");
			}
		}
		return message.toString();
	}
}