org.androidannotations.internal.process.ModelValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of androidannotations Show documentation
The Annotation Processor jar that generates code
There is a newer version: 4.8.0
/**
 * Copyright (C) 2010-2016 eBusiness Information, Excilys Group
 *
 * 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.androidannotations.internal.process;

import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;

import javax.lang.model.element.AnnotationMirror;
import javax.lang.model.element.Element;

import org.androidannotations.AndroidAnnotationsEnvironment;
import org.androidannotations.ElementValidation;
import org.androidannotations.handler.AnnotationHandler;
import org.androidannotations.internal.exception.ValidationException;
import org.androidannotations.internal.model.AnnotationElements;
import org.androidannotations.internal.model.AnnotationElementsHolder;
import org.androidannotations.logger.Logger;
import org.androidannotations.logger.LoggerFactory;

public class ModelValidator {

	private static final Logger LOGGER = LoggerFactory.getLogger(ModelValidator.class);
	private AndroidAnnotationsEnvironment environment;

	public ModelValidator(AndroidAnnotationsEnvironment environment) {
		this.environment = environment;
	}

	public AnnotationElements validate(AnnotationElements extractedModel, AnnotationElementsHolder validatingHolder) throws ValidationException {

		LOGGER.info("Validating elements");
		List failedValidations = new ArrayList<>();

		/*
		 * We currently do not validate the elements on the ancestors, assuming
		 * they've already been validated. This also means some checks such as
		 * unique ids might not be check all situations.
		 */

		for (AnnotationHandler annotationHandler : environment.getHandlers()) {
			if (!annotationHandler.isEnabled()) {
				continue;
			}
			String validatorSimpleName = annotationHandler.getClass().getSimpleName();
			String annotationName = annotationHandler.getTarget();

			Set annotatedElements = extractedModel.getRootAnnotatedElements(annotationName);

			Set validatedAnnotatedElements = new LinkedHashSet<>();

			validatingHolder.putRootAnnotatedElements(annotationName, validatedAnnotatedElements);

			if (!annotatedElements.isEmpty()) {
				LOGGER.debug("Validating with {}: {}", validatorSimpleName, annotatedElements);
			}

			for (Element annotatedElement : annotatedElements) {
				ElementValidation elementValidation = annotationHandler.validate(annotatedElement);

				AnnotationMirror annotationMirror = elementValidation.getAnnotationMirror();
				for (ElementValidation.Error error : elementValidation.getErrors()) {
					LOGGER.error(error.getMessage(), error.getElement(), annotationMirror);
				}

				for (String warning : elementValidation.getWarnings()) {
					LOGGER.warn(warning, elementValidation.getElement(), elementValidation.getAnnotationMirror());
				}

				if (elementValidation.isValid()) {
					validatedAnnotatedElements.add(annotatedElement);
				} else {
					failedValidations.add(elementValidation);
					LOGGER.warn("Element {} invalidated by {}", annotatedElement, annotatedElement, validatorSimpleName);
				}
			}
		}

		if (!failedValidations.isEmpty()) {
			throw new ValidationException(failedValidations);
		}

		return validatingHolder;
	}
}