io.micronaut.serde.processor.jackson.ValidatingAnnotationMapper Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2021 original authors
 *
 * 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
 *
 * https://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 io.micronaut.serde.processor.jackson;

import java.lang.annotation.Annotation;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;

import io.micronaut.core.annotation.AnnotationValue;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.naming.NameUtils;
import io.micronaut.inject.annotation.NamedAnnotationMapper;
import io.micronaut.inject.visitor.VisitorContext;
import io.micronaut.serde.config.annotation.SerdeConfig;

/**
 * Abstract transformer that validate supported members returned by {@link #getSupportedMemberNames()}.
 */
public abstract class ValidatingAnnotationMapper implements NamedAnnotationMapper {

    @Override
    public final List> map(AnnotationValue annotation, VisitorContext visitorContext) {
        Set supported = getSupportedMemberNames();
        final Set memberNames = annotation.getMemberNames();
        final Optional unsupportedMember = memberNames.stream()
                .filter(n -> !supported.contains(n.toString()))
                .findFirst();
        return unsupportedMember.>>map(charSequence -> Collections.singletonList(
                AnnotationValue.builder(SerdeConfig.SerError.class)
                        .value(getErrorMessage(supported, charSequence))
                        .build()
        )).orElseGet(() -> mapValid(annotation, visitorContext));
    }

    private String getErrorMessage(Set supported, CharSequence member) {
        return "Annotation @" + NameUtils.getSimpleName(getName()) + " specifies attribute '" + member + "'"
                       + ". Currently supported attributes include: " + supported;
    }

    /**
     * The transform method will be called for each instances of the annotation returned via this method.
     *
     * @param annotation The annotation values
     * @param visitorContext The context that is being visited
     * @return A list of zero or many annotations and values to map to
     */
    protected abstract List> mapValid(AnnotationValue annotation, VisitorContext visitorContext);

    /**
     * @return The set of annotation member names that are supported.
     */
    protected @NonNull Set getSupportedMemberNames() {
        return Collections.emptySet();
    }
}