001/*
002 * Copyright 2015-2022 Transmogrify LLC, 2022-2023 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.pyranid;
018
019import javax.annotation.Nullable;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025/**
026 * Allows specification of alternate column names for resultset mapping.
027 * <p>
028 * Useful in situations where column names are ugly, inconsistent, or do not map well to camel-case Java property names.
029 * <p>
030 * For example:
031 *
032 * <pre>
033 * class Example {
034 *   &#064;DatabaseColumn({ &quot;systok&quot;, &quot;sys_tok&quot; })
035 *   UUID systemToken;
036 *
037 *   UUID getSystemToken() {
038 *     return systemToken;
039 *   }
040 *
041 *   void setSystemToken(UUID systemToken) {
042 *     this.systemToken = systemToken;
043 *   }
044 * }
045 *
046 * database.queryForObject(&quot;SELECT systok FROM example&quot;, Example.class);
047 * </pre>
048 *
049 * @author <a href="https://www.revetkn.com">Mark Allen</a>
050 * @since 1.0.0
051 */
052@Target({ElementType.FIELD, ElementType.RECORD_COMPONENT})
053@Retention(RetentionPolicy.RUNTIME)
054public @interface DatabaseColumn {
055        @Nullable
056        String[] value();
057}