AbstractElementMirror.java

/**
 * Powerunit - A JDK1.8 test framework
 * Copyright (C) 2014 Mathieu Boretti.
 *
 * This file is part of Powerunit
 *
 * Powerunit is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Powerunit is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Powerunit. If not, see <http://www.gnu.org/licenses/>.
 */
package ch.powerunit.extensions.matchers.common;

import static java.util.Optional.ofNullable;

import java.util.Optional;

import javax.annotation.processing.ProcessingEnvironment;
import javax.lang.model.element.AnnotationMirror;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;

/**
 * @author borettim
 *
 */
public abstract class AbstractElementMirror<E extends Element, R extends AbstractRoundMirrorReferenceToProcessingEnv>
		implements AbstractRoundMirrorSupport<R>, ElementHelper, ProcessingEnvironmentHelper {

	protected final R roundMirror;
	protected final E element;
	protected final Optional<String> doc;
	protected final Optional<TypeElement> annotation;

	public AbstractElementMirror(String annotationType, R roundMirror, E element) {
		this.roundMirror = roundMirror;
		this.element = element;
		this.doc = ofNullable(roundMirror.getElementUtils().getDocComment(element));
		this.annotation = ofNullable(roundMirror.getElementUtils().getTypeElement(annotationType));
	}

	@Override
	public R getRoundMirror() {
		return roundMirror;
	}

	public E getElement() {
		return element;
	}

	public String getParamComment() {
		return doc.map(AbstractElementMirror::extractParamCommentFromJavadoc).orElse(" * \n");
	}

	public Optional<AnnotationMirror> getAnnotationMirror() {
		return annotation.map(a -> getTypeUtils().getDeclaredType(a)).map(a -> element.getAnnotationMirrors().stream()
				.filter(m -> getTypeUtils().isSameType(a, m.getAnnotationType())).findAny().orElse(null));
	}

	@Override
	public ProcessingEnvironment getProcessingEnv() {
		return roundMirror.getProcessingEnv();
	}

	private static String extractParamCommentFromJavadoc(String docComment) {
		boolean insideParam = false;
		StringBuilder sb = new StringBuilder(" * \n");
		for (String line : docComment.split("\\R")) {
			if (insideParam && line.matches("^\\s*@.*$")) {
				insideParam = false;
			}
			if (line.matches("^\\s*@param.*$")) {
				insideParam = true;
			}
			if (insideParam) {
				sb.append(" *").append(line).append("\n");
			}
		}
		return sb.toString();
	}

}