BindByteString.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.ByteString;
import net.morimekta.proto.jdbi.MorimektaJdbiOptions;
import net.morimekta.proto.jdbi.ProtoJdbi;
import net.morimekta.proto.jdbi.v3.util.ByteStringArgument;
import org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizerFactory;
import org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizingAnnotation;
import org.jdbi.v3.sqlobject.customizer.SqlStatementParameterCustomizer;

import java.lang.annotation.Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.lang.reflect.Type;

/**
 * Annotation that can be put on a bind that also ensures the field is handled correctly as a
 * {@code ByteString} data type. Also supports changing the encoding of the type (for {@code VARCHAR}
 * and similar string-like fields).
 */
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@SqlStatementCustomizingAnnotation(BindByteString.Factory.class)
public @interface BindByteString {
    String value() default "";

    MorimektaJdbiOptions.SqlType type() default MorimektaJdbiOptions.SqlType.VARBINARY;

    class Factory implements SqlStatementCustomizerFactory {
        @Override
        public SqlStatementParameterCustomizer createForParameter(Annotation annotation,
                                                                  Class<?> sqlObjectType,
                                                                  Method method,
                                                                  Parameter param,
                                                                  int index,
                                                                  Type paramType) {
            if (!paramType.equals(ByteString.class)) {
                throw new IllegalArgumentException(
                        paramType.getTypeName() + " is not a proto ByteString");
            }

            BindByteString bind = (BindByteString) annotation;
            return (stmt, arg) -> {
                if (arg == null) {
                    var sqlType = ProtoJdbi.getColumnType(bind.type());
                    if (!bind.value().isEmpty()) {
                        stmt.bindNull(bind.value(), sqlType);
                    }
                    stmt.bindNull(index, sqlType);
                } else {
                    var bsa = new ByteStringArgument((ByteString) arg, bind.type());
                    if (!bind.value().isEmpty()) {
                        stmt.bind(bind.value(), bsa);
                    }
                    stmt.bind(index, bsa);
                }
            };
        }
    }
}