org.hibernate.validator.parameternameprovider.ParanamerParameterNameProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hibernate-validator Show documentation

JPMS Module-Info's for a few of the Jakarta Libraries. These will be removed as time goes by

There is a newer version: 62

/*
 * Hibernate Validator, declare and validate application constraints
 *
 * License: Apache License, Version 2.0
 * See the license.txt file in the root directory or .
 */
package org.hibernate.validator.parameternameprovider;

import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.List;
import jakarta.validation.ParameterNameProvider;

import com.thoughtworks.paranamer.AdaptiveParanamer;
import com.thoughtworks.paranamer.CachingParanamer;
import com.thoughtworks.paranamer.Paranamer;

import org.hibernate.validator.internal.engine.DefaultParameterNameProvider;

/**
 * A {@link ParameterNameProvider} implementation backed by the ParaNamer
 * library.
 * 
 * The {@link Paranamer} implementation to use can be passed when creating a {@code ParanamerParameterNameProvider}. By
 * default a {@link AdaptiveParanamer} will be used which is wrapped into a {@link CachingParanamer}. If no parameter
 * names can be obtained from the configured {@code Paranamer}, the default parameter name provider will be used as
 * fall back.
 * 
 * The ParaNamer library must be present on the classpath when using this parameter name provider.
 *
 * @author Gunnar Morling
 * @see ParaNamer web site
 */
public class ParanamerParameterNameProvider implements ParameterNameProvider {

	private final ParameterNameProvider fallBackProvider;
	private final Paranamer paranamer;

	public ParanamerParameterNameProvider() {
		this( null );
	}

	public ParanamerParameterNameProvider(Paranamer paranamer) {
		this.paranamer = paranamer != null ? paranamer : new CachingParanamer( new AdaptiveParanamer() );
		fallBackProvider = new DefaultParameterNameProvider();
	}

	@Override
	public List getParameterNames(Constructor constructor) {
		String[] parameterNames;

		//there are no guarantees regarding thread-safety
		synchronized ( paranamer ) {
			parameterNames = paranamer.lookupParameterNames( constructor, false );
		}

		//either null or an empty array is returned if no names could be retrieved
		if ( parameterNames != null && parameterNames.length == constructor.getParameterCount() ) {
			return Arrays.asList( parameterNames );
		}

		return fallBackProvider.getParameterNames( constructor );
	}

	@Override
	public List getParameterNames(Method method) {
		String[] parameterNames;

		synchronized ( paranamer ) {
			parameterNames = paranamer.lookupParameterNames( method, false );
		}

		if ( parameterNames != null && parameterNames.length == method.getParameterCount() ) {
			return Arrays.asList( parameterNames );
		}

		return fallBackProvider.getParameterNames( method );
	}
}