DocumentValidationException.java

/*
 * (C) Copyright 2014 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * 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.
 *
 * Contributors:
 *     Nicolas Chapurlat <nchapurlat@nuxeo.com>
 */

package org.nuxeo.ecm.core.api.validation;

import org.nuxeo.ecm.core.api.NuxeoException;

/**
 * Exception thrown when some process failed due to {@link ConstraintViolation}.
 *
 * @since 7.1
 */
public class DocumentValidationException extends NuxeoException {

    private static final String MESSAGE_SINGLE = "Constraint violation thrown: '%s'";

    private static final String MESSAGE = "%s constraint violation(s) thrown. First one is: '%s', call "
            + DocumentValidationException.class.getSimpleName() + ".getViolations() to get the others";

    private static final long serialVersionUID = 1L;

    private DocumentValidationReport report;

    public DocumentValidationException(DocumentValidationReport report) {
        super();
        this.report = report;
    }

    public DocumentValidationReport getReport() {
        return report;
    }

    @Override
    public String getMessage() {
        if (report.hasError()) {
            int num = report.numberOfErrors();
            String violationMessage = report.asList().get(0).getMessage(null);
            if (num > 1) {
                return String.format(MESSAGE, report.numberOfErrors(), violationMessage);
            } else {
                return String.format(MESSAGE_SINGLE, violationMessage);
            }
        } else {
            return super.getMessage();
        }
    }

}