org.linkki.tooling.apt.model.AptComponentDeclaration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of linkki-apt Show documentation
The newest version!
/*
 * Copyright Faktor Zehn GmbH.
 *
 * 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.linkki.tooling.apt.model;

import static org.linkki.tooling.apt.util.Constants.CAPTION;
import static org.linkki.tooling.apt.util.Constants.LABEL;

import java.util.List;
import java.util.Optional;

import javax.lang.model.element.AnnotationMirror;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.type.TypeKind;

import org.linkki.core.binding.descriptor.property.annotation.BoundPropertyCreator;
import org.linkki.tooling.apt.util.Constants;
import org.linkki.tooling.apt.util.MethodNameUtils;
import org.linkki.tooling.apt.util.PositionUtil;

import edu.umd.cs.findbugs.annotations.NonNull;

/**
 * A representation of the {@code @UI-Annotation} that declares a component.
 */
public class AptComponentDeclaration implements AptAspectSubject {

    private final List attributes;

    private final Optional modelObject;

    private final Optional modelAttribute;

    private final ExecutableElement element;

    private final AnnotationMirror annotationMirror;

    public AptComponentDeclaration(List attributes, Optional modelObject,
            Optional modelAttribute, ExecutableElement element, AnnotationMirror annotationMirror) {
        this.attributes = attributes;
        this.modelObject = modelObject;
        this.modelAttribute = modelAttribute;
        this.element = element;
        this.annotationMirror = annotationMirror;
    }

    public int getPosition() {
        return PositionUtil.findPositionAttribute(this.getAttributes())
                .map(AptAttribute::getValue)
                .map(Integer.class::cast)
                .orElseThrow(() -> new IllegalStateException("expected position to be an int"));
    }

    public Optional getLabel() {
        return AptAttribute.findByName(this.getAttributes(), LABEL)
                .map(AptAttribute::getValue)
                .map(String.class::cast);
    }

    @NonNull
    public Optional getCaption() {
        return AptAttribute.findByName(this.getAttributes(), CAPTION)
                .map(AptAttribute::getValue)
                .map(String.class::cast);
    }

    public String getPropertyName() {
        return MethodNameUtils.getPropertyName(element);
    }

    public boolean isDirectModelBinding() {
        return element.getReturnType().getKind() == TypeKind.VOID;
    }

    public List getAttributes() {
        return attributes;
    }

    public Optional getModelObject() {
        return modelObject;
    }

    public Optional getModelAttribute() {
        return modelAttribute;
    }

    @Override
    public ExecutableElement getElement() {
        return element;
    }

    @Override
    public AnnotationMirror getAnnotationMirror() {
        return annotationMirror;
    }

    /**
     * Returns whether the annotation uses the standard names for the
     * {@value Constants#MODEL_OBJECT} and {@value Constants#MODEL_ATTRIBUTE} annotation attributes.
     * Only then can we validate their values, because we can't instantiate the
     * {@link BoundPropertyCreator}.
     */
    public boolean isUsingStandardModelBindingAttributes() {
        return AptAttribute.findByName(getAttributes(), Constants.MODEL_OBJECT).isPresent() &&
                AptAttribute.findByName(getAttributes(), Constants.MODEL_ATTRIBUTE).isPresent();
    }
}