001/*
002 * Copyright 2015-2022 Transmogrify LLC, 2022-2026 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 org.jspecify.annotations.Nullable;
020
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026/**
027 * Allows specification of alternate column names for resultset mapping.
028 * <p>
029 * Useful in situations where column names are ugly, inconsistent, or do not map well to camel-case Java property names.
030 * <p>
031 * For example:
032 *
033 * <pre>
034 * class Example {
035 *   &#064;DatabaseColumn({ &quot;systok&quot;, &quot;sys_tok&quot; })
036 *   UUID systemToken;
037 *
038 *   UUID getSystemToken() {
039 *     return systemToken;
040 *   }
041 *
042 *   void setSystemToken(UUID systemToken) {
043 *     this.systemToken = systemToken;
044 *   }
045 * }
046 *
047 * database.query(&quot;SELECT systok FROM example&quot;).fetchObject(Example.class);
048 * </pre>
049 *
050 * @author <a href="https://www.revetkn.com">Mark Allen</a>
051 * @since 1.0.0
052 */
053@Target({ElementType.FIELD, ElementType.RECORD_COMPONENT})
054@Retention(RetentionPolicy.RUNTIME)
055public @interface DatabaseColumn {
056        @Nullable
057        String[] value();
058}