/*
 * Hibernate Validator, declare and validate application constraints
 *
 * License: Apache License, Version 2.0
 * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
 */
package org.hibernate.validator.spi.nodenameprovider;

import org.hibernate.validator.Incubating;

This interface is used to resolve the name of a property node when creating the property path.
Author:
Damir Alibegovic
Since:
6.1.0/**
 * This interface is used to resolve the name of a property node when creating the property path.
 *
 * @author Damir Alibegovic
 * @since 6.1.0
 */
@Incubating
public interface PropertyNodeNameProvider {
	
Returns the resolved name of a property.
 Depending on the subtype of the Property, a different strategy for name resolution could be applied, defaulting to Property.getName(). For example: 
if (property instanceof JavaBeanProperty) { // for instance, generate a property name based on the annotations of the property } else { return property.getName(); } 
Params:
property – who's name needs to be resolved
Returns:
String representing the resolved name/**
	 * Returns the resolved name of a property.
	 * <p>
	 * Depending on the subtype of the {@link Property},
	 * a different strategy for name resolution could be applied, defaulting to {@link Property#getName()}. For example:
	 *
	 * <pre>
	 * if (property instanceof {@link JavaBeanProperty}) {
	 *     // for instance, generate a property name based on the annotations of the property
	 * } else {
	 *     return property.getName();
	 * }
	 * </pre>
	 *
	 * @param property who's name needs to be resolved
	 *
	 * @return String representing the resolved name
	 */
	String getName(Property property);
}