001/*license*\
002   Codelet: Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com)
003
004   This software is dual-licensed under the:
005   - Lesser General Public License (LGPL) version 3.0 or, at your option, any later version;
006   - Apache Software License (ASL) version 2.0.
007
008   Either license may be applied at your discretion. More information may be found at
009   - http://en.wikipedia.org/wiki/Multi-licensing.
010
011   The text of both licenses is available in the root directory of this project, under the names "LICENSE_lgpl-3.0.txt" and "LICENSE_asl-2.0.txt". The latest copies may be downloaded at:
012   - LGPL 3.0: https://www.gnu.org/licenses/lgpl-3.0.txt
013   - ASL 2.0: http://www.apache.org/licenses/LICENSE-2.0.txt
014\*license*/
015package  com.github.aliteralmind.codelet.simplesig;
016   import  com.github.xbn.lang.ObjectOrCrashIfNull;
017   import  java.lang.reflect.Method;
018/**
019   <p>Simple-parameter-name signature for a function.</p>
020
021 * @see  <a href="MethodSigSearchTerm.html#xmpl_method">Example</a>
022 * @since  0.1.0
023 * @author  Copyright (C) 2014, Jeff Epstein ({@code aliteralmind __DASH__ github __AT__ yahoo __DOT__ com}), dual-licensed under the LGPL (version 3.0 or later) or the ASL (version 2.0). See source code for details. <a href="http://codelet.aliteralmind.com">{@code http://codelet.aliteralmind.com}</a>, <a href="https://github.com/aliteralmind/codelet">{@code https://github.com/aliteralmind/codelet}</a>
024 **/
025public class MethodSimpleParamSig extends SimpleParamNameSignature  {
026   /**
027      <p>Create a new instance from a method.</p>
028
029    * <p>Equal to
030      <br/> &nbsp; &nbsp; <code>{@link SimpleParamNameSignature#SimpleParamNameSignature(Member, Class[]) super}(method, method.{@link java.lang.reflect.Method#getParameterTypes() getParameterTypes}())</code></p>
031
032    * @param  method  May not be {@code null}.
033    */
034   public MethodSimpleParamSig(Method method)  {
035      super(method, ObjectOrCrashIfNull.<Method>get(method, "method").getParameterTypes());
036   }
037   /**
038      <p>The method object.</p>
039
040    * @return  <code>(Method){@link SimpleParamNameSignature#getMember() getMember}()*</code>
041
042    * @see  #MethodSimpleParamSig(Method)
043    */
044   public Method getMethod()  {
045      return  (Method)getMember();
046   }
047   /**
048    * @return  <code>{@link #getMethodName() getMethodName}() + {@link SimpleParamNameSignature#getWithParens() getWithParens}()*</code>
049    */
050   public String toString()  {
051      return  getMethodName() + getWithParens();
052   }
053   /**
054    * @return  <code>{@link #getMethod() getMethod}().{@link java.lang.reflect.Method#getName() getName}()</code>
055    */
056   public String getMethodName()  {
057      return  getMethod().getName();
058   }
059}