1 /*
   2  * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.source.util;
  27 
  28 import javax.lang.model.element.VariableElement;
  29 
  30 /**
  31  * A provider for parameter names when the parameter names are not determined from
  32  * a reliable source, like a classfile.
  33  *
  34  * @since 13
  35  */
  36 public interface ParameterNameProvider {
  37 
  38     /**
  39      * Infer a parameter name for the given parameter. The implementations of this method
  40      * should infer parameter names in such a way that the parameter names are distinct
  41      * for any given owning method.
  42      *
  43      * If the implementation of this method returns null, an automatically synthesized name is used.
  44      *
  45      * @param parameter the parameter for which the name should be inferred.
  46      * @return a user-friendly name for the parameter, or null if unknown
  47      */
  48     public CharSequence getParameterName(VariableElement parameter);
  49 
  50 }