com.google.gwt.query.client.GQ Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwtquery Show documentation
The newest version!
/*
 * Copyright 2013, The gwtquery team.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.gwt.query.client;

import com.google.gwt.query.client.builders.JsonBuilder;
import com.google.gwt.query.client.builders.JsonFactory;
import com.google.gwt.query.client.plugins.ajax.Ajax.AjaxTransport;
import com.google.gwt.query.client.plugins.ajax.AjaxTransportJs;
import com.google.gwt.query.vm.AjaxTransportJre;
import com.google.gwt.query.vm.JsonFactoryJre;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

/**
 * A set of useful methods for gQuery which can be run in browser or JVM.
 */
public abstract class GQ {

  private static AjaxTransport ajaxTransport;

  private static JsonFactory jsonFactory;

  private static Boolean isClient;

  public static IsProperties create() {
    return getFactory().create();
  }

  /**
   * Create an instance of a JsonBuilder object whose type is .
   */
  public static  T create(Class clz) {
    return getFactory().create(clz);
  }

  /**
   * Create an instance of a JsonBuilder object whose type is 
   * and set the the underlying properties object.
   */
  public static  T create(Class clz, IsProperties obj) {
    T ret = create(clz);
    ret.load(obj.getDataImpl());
    return ret;
  }

  /**
   * Create an instance of a JsonBuilder object whose type is 
   * and load all its properties from a json string.
   */
  public static  T create(Class clz, String payload) {
    T ret = create(clz);
    ret.load(payload);
    return ret;
  }

  /**
   * Create an instance of IsProperties, a Properties JavaScriptObject in the client
   * side and a proxy object in the JVM.
   */
  public static IsProperties create(String s) {
    return getFactory().create(s);
  }

  /**
   * Create an instance of IsProperties, a Properties JavaScriptObject in the client
   * side and a proxy object in the JVM.
   *
   * If fixJson is set, we correct certain errors in the Json string. It is useful
   * for generating Properties using java strings, so as we can use a more relaxed
   * syntax.
   */
  public static IsProperties create(String s, boolean fixJson) {
    return getFactory().create(fixJson ? Properties.wrapPropertiesString(s) : s);
  }

  /**
   * Return the appropriate transport implementation depending on the runtime
   * environment: browser or JVM.
   */
  public static AjaxTransport getAjaxTransport() {
    initFactory();
    return ajaxTransport;
  }

  private static JsonFactory getFactory() {
    initFactory();
    return jsonFactory;
  }

  /**
   * Change the default Ajax transport by a customized one, useful for
   * testing purposes.
   */
  public static void setAjaxTransport(AjaxTransport transport) {
    ajaxTransport = transport;
  }

  /*
   * Create the appropriate version of factories depending
   * if whether we are running dev-mode
   */
  private static void initFactory() {
    if (jsonFactory == null) {
      try {
        // We use reflection because the server side should not
        // depend on gwt-servlet nor gwt-dev. Hence if GWT is not
        // in our classpath means that we are in server side, otherwise
        // we use GWT to figure out if we are running devmode.
        // This is run once, so no performance issues to worry about.
        Class.forName("com.google.gwt.core.shared.GWTBridge");
        Class gwt = Class.forName("com.google.gwt.core.shared.GWT");
        Method method = gwt.getMethod("isClient");
        Object ret = method.invoke(null);
        if (ret instanceof Boolean && ((Boolean) ret)) {
          // We are running DevMode, so create Js versions of the factories
          method = gwt.getMethod("create", Class.class);
          ret = method.invoke(null,
              new Object[] {JsonFactory.class});
          jsonFactory = (JsonFactory) ret;
          ajaxTransport = new AjaxTransportJs();
          return;
        }
      } catch (ClassNotFoundException ignore) {
      } catch (NoSuchMethodException ignore) {
      } catch (SecurityException ignore) {
      } catch (IllegalAccessException ignore) {
      } catch (IllegalArgumentException ignore) {
      } catch (InvocationTargetException ignore) {
      }
      // We are running in the JVM, so create Jre versions.
      jsonFactory = new JsonFactoryJre();
      ajaxTransport = new AjaxTransportJre();
    }
  }
}