MethodSearchResult.java

/*
** Module   : MethodSearchResult.java
** Abstract : Returns the result from a method lookup.
**
** Copyright (c) 2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA  20230928 Initial version - extracted from ClassDefinition.
*/

/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program 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 Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.uast;

/**
 * Returns the result from a method lookup.
 */
public class MethodSearchResult
{
   /** The method that was found. */
   final MethodData data;
   
   /** Type overrides for fuzzy matches. */
   final private String[] overrides;
   
   /**
    * Flag indicating if this result is a pseudo-dynamic call caused by poly arguments, when multiple
    * overload targets were found during fuzzy match. 
    */
   final private boolean polyArgs;

   /**
    * Create an dynamic invocation instance.
    */
   public MethodSearchResult()
   {
      data         = null;
      overrides    = null;
      polyArgs = false;
   }

   /**
    * Create an instance using the given result.
    * 
    * @param    data
    *           The result of the search.
    * @param    overrides
    *           Type overrides for fuzzy matches.
    */
   MethodSearchResult(MethodData data, String[] overrides)
   {
      this.data      = data;
      this.overrides = overrides;
      this.polyArgs   = false;
   }
   
   /**
    * Create an instance using the given result.
    * 
    * @param    data
    *           The result of the search.
    * @param    overrides
    *           Type overrides for fuzzy matches.
    * @param    polyArgs
    *           Flag indicating if this result is a pseudo-dynamic call caused by poly arguments, when 
    *           multiple overload targets were found during fuzzy match. 
    */
   MethodSearchResult(MethodData data, String[] overrides, boolean polyArgs)
   {
      this.data      = data;
      this.overrides = overrides;
      this.polyArgs   = polyArgs;
   }
   
   /**
    * Obtain any types overrides which are needed because of fuzzy matching.
    *  
    * @return   The type overrides defined for this match or {@code null} if there are no overrides.
    */
   public String[] getOverrides()
   {
      return overrides;
   }
   
   /**
    * Get the resolved {@link #data method}.
    *  
    * @return   See above.
    */
   public MethodData getData()
   {
      return data;
   }

   /**
    * Reports if this is a dynamic invocation.
    * 
    * @return   {@code true} if this is a dynamic invocation.
    */
   boolean isDynamic()
   {
      return data == null || polyArgs;
   }

   /**
    * Check if the method call has {@link #polyArgs poly arguments}.
    * 
    * @return   The state of the {@link #polyArgs} flag.
    */
   boolean isPolyArgs()
   {
      return polyArgs;
   }
}