com.gabrielittner.auto.value.util.Property Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of auto-value-extension-util Show documentation
Utilities for AutoValue extensions
There is a newer version: 0.4.0
Show newest version
package com.gabrielittner.auto.value.util;

import com.google.auto.value.extension.AutoValueExtension;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.squareup.javapoet.TypeName;
import java.util.Map;
import java.util.Set;
import javax.lang.model.element.ExecutableElement;

/**
 * A Property of the AutoValue annotated class.
 *
 * This convenience class wraps the {@link ExecutableElement} for properties provided by the
 * AutoValueExtension.Context to make accessing values easier.
 *
 * It is recommended that you get the {@link #humanName} directly from the properties returned from
 * the AutoValueExtension.Context#properties method.
 *
 *  * ImmutableList.Builder values = ImmutableList.builder();
 * for (Map.Entry entry : context.properties().entrySet()) {
 *   values.add(new Property(entry.getKey(), entry.getValue()));
 * }
 * return values.build();
 * 
 */
public class Property {

    /**
     * Builds a List of {@link Property} for the given {@link AutoValueExtension.Context}.
     */
    public static ImmutableList buildProperties(AutoValueExtension.Context context) {
        ImmutableList.Builder values = ImmutableList.builder();
        for (Map.Entry entry : context.properties().entrySet()) {
            values.add(new Property(entry.getKey(), entry.getValue()));
        }
        return values.build();
    }

    private final String methodName;
    private final String humanName;
    private final ExecutableElement element;
    private final TypeName type;
    private final ImmutableSet annotations;

    public Property(String humanName, ExecutableElement element) {
        this.methodName = element.getSimpleName().toString();
        this.humanName = humanName;
        this.element = element;
        type = TypeName.get(element.getReturnType());
        annotations = ElementUtil.buildAnnotations(element);
    }

    /**
     * The method name of the property.
     */
    public String methodName() {
        return methodName;
    }

    /**
     * The human readable name of the property. If all properties use {@code get} or {@code is}
     * prefixes, this name will be different from {@link #methodName()}.
     */
    public String humanName() {
        return humanName;
    }

    /**
     * The underlying ExecutableElement representing the get method of the property.
     */
    public ExecutableElement element() {
        return element;
    }

    /**
     * The return type of the property.
     */
    public TypeName type() {
        return type;
    }

    /**
     * The set of annotations present on the original property.
     */
    public Set annotations() {
        return annotations;
    }

    /**
     * True if the property can be null.
     */
    public Boolean nullable() {
        return annotations.contains("Nullable");
    }
}