org.wisepersist.gradle.plugins.gwt.GwtDevOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-gradle-plugin Show documentation
Gradle plugin to support GWT (http://www.gwtproject.org/) related tasks.
There is a newer version: 1.1.19
/**
 * Copyright (C) 2013-2017 Steffen Schaefer
 *
 * 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 org.wisepersist.gradle.plugins.gwt;

import java.io.File;

/**
 * Defines the options known by the {@link GwtDev} task.
 */
public interface GwtDevOptions {

  Boolean getNoserver();

  /**
   * Sets the "-noserver" flag that causes the GWT dev mode to not start the
   * internal webserver (jetty) but only the code server that runs the GWT
   * client part. The developer must ensure that an appropriate webserver is
   * running to serve the static files/backend.
   *
   * @param noserver
   *            true if the "-noserver" flag should be set.
   */
  void setNoserver(Boolean noserver);

  Integer getPort();

  /**
   * Sets the "-port" option.
   *
   * @param port Valid range is [1, 65535]
   */
  void setPort(Integer port);

  String getWhitelist();

  /**
   * Sets the "-whitelist" option
   *
   * @param whitelist The white list specified.
   */
  void setWhitelist(String whitelist);

  String getBlacklist();

  /**
   * Sets the "-blacklist" option.
   *
   * @param blacklist The black list specified.
   */
  void setBlacklist(String blacklist);

  File getLogDir();

  /**
   * Sets the "-logdir" option.
   *
   * @param logDir The log dir specified.
   */
  void setLogDir(File logDir);

  String getBindAddress();

  /**
   * Sets the "-bindAddress" option.
   *
   * @param bindAddress The bind address option specified.
   */
  void setBindAddress(String bindAddress);

  Integer getCodeServerPort();

  /**
   * Sets the "-codeServerPort" option.
   *
   * @param codeServerPort Valid range is [1, 65535]
   */
  void setCodeServerPort(Integer codeServerPort);

  String getServer();

  /**
   * Sets the "-server" option.
   *
   * @param server The server option specified.
   */
  void setServer(String server);

  String getStartupUrl();

  /**
   * Sets the "-startupUrl" option.
   *
   * @param startupUrl The startup Url specified.
   */
  void setStartupUrl(String startupUrl);

  Boolean getAutoPort();

  /**
   * Is set to true, this causes the "-port" to be automatically assigned
   * using a free port.
   *
   * @param autoPort Whether to be automatically assigned using a free port
   * for "-port" or not.
   */
  void setAutoPort(Boolean autoPort);

  Boolean getAutoCodeServerPort();

  /**
   * Is set to true, this causes the "-codeServerPort" to be automatically
   * assigned using a free port.
   *
   * @param autoCodeServerPort Whether to be automatically assigned using
   * a free port for "-codeServerPort" or not.
   */
  void setAutoCodeServerPort(Boolean autoCodeServerPort);

  Boolean getSuperDevMode();

  /**
   * Is set to true, this causes the "-superDevMode" (added in GWT 2.7)
   * flag to be added.
   *
   * @param superDevMode Whether to add "-superDevMode" (added in GWT 2.7)
   * flag or not.
   */
  void setSuperDevMode(Boolean superDevMode);

  Boolean getStartServer();

  /**
   * Is set to true, this causes the "-startServer" (added in GWT 2.7)
   * flag to be added.
   *
   * @param startServer Whether to add "-startServer" (added in GWT 2.7)
   * flag or not.
   */
  void setStartServer(Boolean startServer);
}