Wrapped.java

/*
 * Copyright 2025-present 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.mongodb.core.mapping;

/**
 * Marker interface for objects that wrap another object, providing a way to retrieve the wrapped value.
 *
 * @author Mark Paluch
 * @since 5.0
 */
public interface Wrapped {

	/**
	 * Returns the wrapped value.
	 *
	 * @return
	 */
	Object getTarget();

	/**
	 * Unwraps the given object if it is an instance of {@link Wrapped}. If not, returns the object as-is.
	 *
	 * @param object the object to unwrap, must not be {@literal null}.
	 * @return the unwrapped object or the original object if it is not wrapped.
	 */
	static <T> T getTargetObject(T object) {
		return object instanceof Wrapped w ? (T) w.getTarget() : object;
	}

}