/*
* Copyright (c) 2019, 2020, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.source.util;
import javax.lang.model.element.VariableElement;
A provider for parameter names when the parameter names are not determined from
a reliable source, like a classfile.
Since: 13
/**
* A provider for parameter names when the parameter names are not determined from
* a reliable source, like a classfile.
*
* @since 13
*/
public interface ParameterNameProvider {
Infer a parameter name for the given parameter. The implementations of this method
should infer parameter names in such a way that the parameter names are distinct
for any given owning method.
If the implementation of this method returns null, an automatically synthesized name is used.
Params: - parameter – the parameter for which the name should be inferred
Returns: a user-friendly name for the parameter, or null if unknown
/**
* Infer a parameter name for the given parameter. The implementations of this method
* should infer parameter names in such a way that the parameter names are distinct
* for any given owning method.
*
* If the implementation of this method returns null, an automatically synthesized name is used.
*
* @param parameter the parameter for which the name should be inferred
* @return a user-friendly name for the parameter, or null if unknown
*/
public CharSequence getParameterName(VariableElement parameter);
}