/*
 * Copyright 2021-2025 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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 org.springframework.data.jpa.repository.query;

import jakarta.persistence.ParameterMode;

import java.util.Objects;

import org.jspecify.annotations.Nullable;

/**
 * This class represents a Stored Procedure Parameter and an instance of the annotation
 * {@link jakarta.persistence.StoredProcedureParameter}.
 *
 * @author Gabriel Basilio
 * @author Greg Turnquist
 * @author Thorben Janssen
 */
class ProcedureParameter {

	@Nullable private final String name;
	private final int position;
	private final ParameterMode mode;
	private final Class<?> type;

	ProcedureParameter(@Nullable String name, int position, ParameterMode mode, Class<?> type) {

		this.name = name;
		this.position = position;
		this.mode = mode;
		this.type = type;
	}

	/**
	 * @return the parameter name. Can be {@literal null}.
	 */
	@Nullable
	String getName() {
		return name;
	}

	/**
	 * @return the {@code one} based parameter position as listed in
	 *         {@link jakarta.persistence.NamedStoredProcedureQuery#parameters()}
	 * @since 3.2.6
	 */
	int getPosition() {
		return position;
	}

	ParameterMode getMode() {
		return mode;
	}

	Class<?> getType() {
		return type;
	}

	@Override
	public boolean equals(Object o) {

		if (this == o) {
			return true;
		}

		if (!(o instanceof ProcedureParameter that)) {
			return false;
		}

		return Objects.equals(name, that.name) && mode == that.mode && Objects.equals(type, that.type);
	}

	@Override
	public int hashCode() {
		return Objects.hash(name, mode, type);
	}

	@Override
	public String toString() {
		return "ProcedureParameter{" + "name='" + name + '\'' + ", position=" + position + ", mode=" + mode + ", type="
				+ type + '}';
	}
}
