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.NonNull;
020
021import javax.annotation.concurrent.ThreadSafe;
022
023/**
024 * Encapsulates a parameter intended for SQL {@code IN} list expansion.
025 * <p>
026 * Standard instances may be constructed via {@link Parameters#inList(java.util.Collection)},
027 * {@link Parameters#inList(Object[])}, or the primitive-array overloads.
028 * <p>
029 * Implementations should be threadsafe.
030 *
031 * @author <a href="https://www.revetkn.com">Mark Allen</a>
032 * @since 4.0.0
033 */
034@ThreadSafe
035public interface InListParameter {
036        /**
037         * Gets the elements to be expanded into SQL {@code IN} list placeholders.
038         * Elements must be non-empty.
039         *
040         * @return the elements for the {@code IN} list
041         */
042        @NonNull
043        Object @NonNull [] getElements();
044}