001    /*
002     * Copyright © 2008, 2009 Pedro Agulló Soliveres.
003     * 
004     * This file is part of DirectJNgine.
005     *
006     * DirectJNgine is free software: you can redistribute it and/or modify
007     * it under the terms of the GNU General Public License as published by
008     * the Free Software Foundation, either version 3 of the License.
009     *
010     * Commercial use is permitted to the extent that the code/component(s)
011     * do NOT become part of another Open Source or Commercially developed
012     * licensed development library or toolkit without explicit permission.
013     *
014     * DirectJNgine is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
017     * GNU General Public License for more details.
018     *
019     * You should have received a copy of the GNU General Public License
020     * along with DirectJNgine.  If not, see <http://www.gnu.org/licenses/>.
021     * 
022     * This software uses the ExtJs library (http://extjs.com), which is 
023     * distributed under the GPL v3 license (see http://extjs.com/license).
024     */
025    
026    package com.softwarementors.extjs.djn.api;
027    
028    import java.lang.reflect.Method;
029    import java.util.Map;
030    
031    import com.google.gson.JsonArray;
032    import com.softwarementors.extjs.djn.StringUtils;
033    
034    public class RegisteredMethod {
035    
036      private RegisteredAction action;
037      private String name;
038      private Method method;
039      private boolean formHandler;
040      private boolean handleDataAsJsonArray;
041      
042      /* package */ RegisteredMethod( RegisteredAction action, String name, Method method, boolean formHandler) {
043        assert action != null;
044        assert !StringUtils.isEmpty(name);
045        assert method != null;
046    
047        this.name = name;
048        this.method = method;
049        this.formHandler = formHandler;
050        this.handleDataAsJsonArray = !formHandler && method.getParameterTypes().length == 1 && method.getParameterTypes()[0].equals( JsonArray.class);
051        assert !this.formHandler || isValidFormHandlingMethod(method);
052        
053        this.action = action;
054        assert !action.hasMethod(this.getName());
055        action.addMethod(this);
056      }
057      
058      public static boolean isValidFormHandlingMethod( Method method ) {
059        assert method != null;
060        
061        return method.getParameterTypes().length == 2 && method.getParameterTypes()[0].equals( Map.class) || !method.getParameterTypes()[1].equals( Map.class);
062      }
063      
064      public RegisteredAction getAction() {
065        return this.action;
066      }
067      
068      public String getName() {
069        return this.name;
070      }
071    
072      public Method getMethod() {
073        return this.method;
074      }
075    
076      public Class<?>[] getParameterTypes() {
077        return this.method.getParameterTypes();
078      }
079      
080      public int getParameterCount() {
081        return getParameterTypes().length;
082      }
083    
084      public Class<?> getReturnType() {
085        return this.method.getReturnType();
086      }
087      
088      public boolean getFormHandler() {
089        return this.formHandler;
090      }
091    
092      public String getActionName() {
093        return getAction().getName();
094      }
095      
096      public String getFullName() {
097        return getActionName() + "." + getName();
098      }
099    
100      public Class<?> getActionClass() {
101        return getAction().getActionClass();
102      }
103    
104      public int getClientParameterCount() {
105        // If this is a form handler, then the client must pass just one parameter
106        if( getFormHandler() ) {
107          return 1;
108        }
109        return getParameterCount();
110      }
111      
112      public boolean getHandleDataAsJsonArray() {
113        return this.handleDataAsJsonArray;
114      }
115    }