RegisterMessageMapper.java

/*
 * Copyright 2019 Providence Authors
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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 net.morimekta.proto.jdbi.v3.annotations;

import com.google.protobuf.MessageOrBuilder;
import net.morimekta.proto.jdbi.annotations.FieldColumn;
import org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizer;
import org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizerFactory;
import org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizingAnnotation;

import java.lang.annotation.Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Method;

import static net.morimekta.proto.jdbi.v3.annotations.RegisterMessageMappers.Factory.createForAnnotations;

/**
 * Register row and column mappers for proto `Message` types.
 */
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
@Repeatable(RegisterMessageMappers.class)
@SqlStatementCustomizingAnnotation(RegisterMessageMapper.Factory.class)
public @interface RegisterMessageMapper {
    /**
     * @return The message class to register mappers for.
     */
    Class<? extends MessageOrBuilder> value();

    /**
     * @return Custom field-to-column mappings.
     */
    FieldColumn[] fields() default {};

    /**
     * Factory for creating the message mapper statement customizer.
     */
    class Factory implements SqlStatementCustomizerFactory {
        /**
         * {@inheritDoc}
         */
        @Override
        public SqlStatementCustomizer createForType(Annotation annotation, Class<?> sqlObjectType) {
            RegisterMessageMapper register = (RegisterMessageMapper) annotation;
            return createForAnnotations(register);
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public SqlStatementCustomizer createForMethod(Annotation annotation, Class<?> sqlObjectType, Method method) {
            RegisterMessageMapper register = (RegisterMessageMapper) annotation;
            return createForAnnotations(register);
        }
    }
}