package org.testng.xml;

import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.testng.ITestObjectFactory;
import org.testng.TestNG;
import org.testng.collections.Lists;
import org.testng.collections.Maps;
import org.testng.internal.RuntimeBehavior;
import org.testng.internal.Utils;
import org.testng.util.Strings;

import static org.testng.xml.XmlSuite.ParallelMode.skipDeprecatedValues;

This class describes the tag <suite> in testng.xml. /** This class describes the tag &lt;suite&gt; in testng.xml. */
public class XmlSuite implements Cloneable {
  
Parallel modes. /** Parallel modes. */
  public enum ParallelMode {
    TESTS("tests", false),
    METHODS("methods"),
    CLASSES("classes"),
    INSTANCES("instances"),
    NONE("none", false),
    @Deprecated
    TRUE("true"),
    @Deprecated
    FALSE("false", false);

    private final String name;
    private final boolean isParallel;

    ParallelMode(String name) {
      this(name, true);
    }

    ParallelMode(String name, boolean isParallel) {
      this.name = name;
      this.isParallel = isParallel;
    }

    public static XmlSuite.ParallelMode getValidParallel(String parallel) {
      if (parallel == null) {
        return ParallelMode.NONE;
      }
      try {
        return XmlSuite.ParallelMode.valueOf(parallel.toUpperCase());
      } catch (IllegalArgumentException e) {
        return ParallelMode.NONE;
      }
    }

    public static ParallelMode skipDeprecatedValues(ParallelMode parallel) {
      if (parallel == ParallelMode.TRUE) {
        Utils.log(
            "XmlSuite",
            1,
            "[WARN] 'parallel' value 'true' is deprecated, default value will be used instead: '"
                + ParallelMode.METHODS
                + "'.");
        return ParallelMode.METHODS;
      }

      if (parallel == ParallelMode.FALSE) {
        Utils.log(
            "XmlSuite",
            1,
            "[WARN] 'parallel' value 'false' is deprecated, default value will be used instead: '"
                + ParallelMode.NONE
                + "'.");
        return ParallelMode.NONE;
      }

      return parallel;
    }

    public boolean isParallel() {
      return isParallel;
    }

    @Override
    public String toString() {
      return name;
    }
  }

  
Configuration failure policy options. /** Configuration failure policy options. */
  public enum FailurePolicy {
    SKIP("skip"),
    CONTINUE("continue");

    private final String name;

    FailurePolicy(String name) {
      this.name = name;
    }

    public static FailurePolicy getValidPolicy(String policy) {
      if (policy == null) {
        return null;
      }
      try {
        return XmlSuite.FailurePolicy.valueOf(policy.toUpperCase());
      } catch (IllegalArgumentException e) {
        return null;
      }
    }

    @Override
    public String toString() {
      return name;
    }
  }

  private String m_test;

  
The default suite name TODO CQ is this OK as a default name. /** The default suite name TODO CQ is this OK as a default name. */
  private static final String DEFAULT_SUITE_NAME = "Default Suite";

  
The suite name (defaults to DEFAULT_SUITE_NAME). /** The suite name (defaults to DEFAULT_SUITE_NAME). */
  private String m_name = DEFAULT_SUITE_NAME;

  
The suite verbose flag (0 to 10). /** The suite verbose flag (0 to 10). */
  public static final Integer DEFAULT_VERBOSE = 1;

  private Integer m_verbose = null;

  public static final ParallelMode DEFAULT_PARALLEL = ParallelMode.NONE;
  private ParallelMode m_parallel = DEFAULT_PARALLEL;

  private String m_parentModule = "";
  private String m_guiceStage = "";

  
Whether to SKIP or CONTINUE to re-attempt failed configuration methods. /** Whether to SKIP or CONTINUE to re-attempt failed configuration methods. */
  public static final FailurePolicy DEFAULT_CONFIG_FAILURE_POLICY = FailurePolicy.SKIP;

  private FailurePolicy m_configFailurePolicy = DEFAULT_CONFIG_FAILURE_POLICY;

  
JUnit compatibility flag. /** JUnit compatibility flag. */
  public static final Boolean DEFAULT_JUNIT = Boolean.FALSE;

  private Boolean m_isJUnit = DEFAULT_JUNIT;

  
Mixed mode flag. /** Mixed mode flag. */
  public static final Boolean DEFAULT_MIXED = Boolean.FALSE;

  public static final Boolean DEFAULT_SKIP_FAILED_INVOCATION_COUNTS = Boolean.FALSE;
  private Boolean m_skipFailedInvocationCounts = DEFAULT_SKIP_FAILED_INVOCATION_COUNTS;

  
The thread count. /** The thread count. */
  public static final Integer DEFAULT_THREAD_COUNT = 5;

  private int m_threadCount = DEFAULT_THREAD_COUNT;

  
Thread count for the data provider pool. /** Thread count for the data provider pool. */
  public static final Integer DEFAULT_DATA_PROVIDER_THREAD_COUNT = 10;

  private int m_dataProviderThreadCount = DEFAULT_DATA_PROVIDER_THREAD_COUNT;

  
By default, a method failing will cause all instances of that class to skip. /** By default, a method failing will cause all instances of that class to skip. */
  public static final Boolean DEFAULT_GROUP_BY_INSTANCES = false;

  private Boolean m_groupByInstances = DEFAULT_GROUP_BY_INSTANCES;

  public static final Boolean DEFAULT_ALLOW_RETURN_VALUES = Boolean.FALSE;
  private Boolean m_allowReturnValues = DEFAULT_ALLOW_RETURN_VALUES;

  
The packages containing test classes. /** The packages containing test classes. */
  private List<XmlPackage> m_xmlPackages = Lists.newArrayList();

  
Suite level method selectors. /** Suite level method selectors. */
  private List<XmlMethodSelector> m_methodSelectors = Lists.newArrayList();

  
Tests in suite. /** Tests in suite. */
  private List<XmlTest> m_tests = Lists.newArrayList();

  
Suite level parameters. /** Suite level parameters. */
  private Map<String, String> m_parameters = Maps.newHashMap();

  
Name of the XML file. /** Name of the XML file. */
  private String m_fileName;

  
Time out for methods/tests. /** Time out for methods/tests. */
  private String m_timeOut;

  
List of child XML suites specified using  tags. /** List of child XML suites specified using <suite-file> tags. */
  private List<XmlSuite> m_childSuites = Lists.newArrayList();

  
Parent XML suite if this suite was specified in another suite using  tag. /** Parent XML suite if this suite was specified in another suite using <suite-file> tag. */
  private XmlSuite m_parentSuite;

  private List<String> m_suiteFiles = Lists.newArrayList();

  private ITestObjectFactory m_objectFactory;

  private List<String> m_listeners = Lists.newArrayList();

  public static final Boolean DEFAULT_PRESERVE_ORDER = Boolean.TRUE;
  private Boolean m_preserveOrder = DEFAULT_PRESERVE_ORDER;

  private List<String> m_includedGroups = Lists.newArrayList();
  private List<String> m_excludedGroups = Lists.newArrayList();
  private XmlMethodSelectors m_xmlMethodSelectors;
  private boolean parsed = false;

  public void setParsed(boolean parsed) {
    this.parsed = parsed;
  }

  
Returns:
- true if the current XmlSuite has already been parsed./** @return - <code>true</code> if the current {@link XmlSuite} has already been parsed. */
  public boolean isParsed() {
    return parsed;
  }

  
Returns:
The fileName./** @return The fileName. */
  public String getFileName() {
    return m_fileName;
  }

  
Params:
fileName – The fileName to set./** @param fileName The fileName to set. */
  public void setFileName(String fileName) {
    m_fileName = fileName;
  }

  
Returns the parallel mode.
Returns:
The parallel mode./**
   * Returns the parallel mode.
   *
   * @return The parallel mode.
   */
  public ParallelMode getParallel() {
    return m_parallel;
  }

  public String getParentModule() {
    return m_parentModule;
  }

  public String getGuiceStage() {
    return m_guiceStage;
  }

  public ITestObjectFactory getObjectFactory() {
    return m_objectFactory;
  }

  public void setObjectFactory(ITestObjectFactory objectFactory) {
    m_objectFactory = objectFactory;
  }

  
Params:
parallel – The String value
Deprecated:
Use #setParallel(XmlSuite.ParallelMode) instead/**
   * @param parallel The String value
   * @deprecated Use #setParallel(XmlSuite.ParallelMode) instead
   */
  @Deprecated
  public void setParallel(String parallel) {
    if (parallel == null) {
      setParallel((ParallelMode) null);
    } else {
      setParallel(XmlSuite.ParallelMode.getValidParallel(parallel));
    }
  }

  
Sets the parallel mode.
Params:
parallel – The parallel mode./**
   * Sets the parallel mode.
   *
   * @param parallel The parallel mode.
   */
  public void setParallel(ParallelMode parallel) {
    if (parallel == null) {
      m_parallel = DEFAULT_PARALLEL;
    } else {
      m_parallel = skipDeprecatedValues(parallel);
    }
  }

  public void setParentModule(String parentModule) {
    m_parentModule = parentModule;
  }

  public void setGuiceStage(String guiceStage) {
    m_guiceStage = guiceStage;
  }

  
Sets the configuration failure policy.
Params:
configFailurePolicy – The config failure policy./**
   * Sets the configuration failure policy.
   *
   * @param configFailurePolicy The config failure policy.
   */
  public void setConfigFailurePolicy(FailurePolicy configFailurePolicy) {
    m_configFailurePolicy = configFailurePolicy;
  }

  
Returns the configuration failure policy.
Returns:
The configuration failure policy./**
   * Returns the configuration failure policy.
   *
   * @return The configuration failure policy.
   */
  public FailurePolicy getConfigFailurePolicy() {
    return m_configFailurePolicy;
  }

  
Returns the verbose.
Returns:
The verbose./**
   * Returns the verbose.
   *
   * @return The verbose.
   */
  public Integer getVerbose() {
    return m_verbose != null ? m_verbose : TestNG.DEFAULT_VERBOSE;
  }

  
Set the verbose.
Params:
verbose – The verbose to set./**
   * Set the verbose.
   *
   * @param verbose The verbose to set.
   */
  public void setVerbose(Integer verbose) {
    m_verbose = verbose;
  }

  
Returns the name.
Returns:
The name./**
   * Returns the name.
   *
   * @return The name.
   */
  public String getName() {
    return m_name;
  }

  
Sets the name.
Params:
name – The name to set./**
   * Sets the name.
   *
   * @param name The name to set.
   */
  public void setName(String name) {
    if (Strings.isNullOrEmpty(name)) {
      throw new IllegalArgumentException("Suite name cannot be null (or) empty.");
    }
    m_name = name;
  }

  
Returns the test.
Returns:
The test./**
   * Returns the test.
   *
   * @return The test.
   */
  public String getTest() {
    return m_test;
  }

  
Returns the tests.
Returns:
The tests./**
   * Returns the tests.
   *
   * @return The tests.
   */
  public List<XmlTest> getTests() {
    return m_tests;
  }

  // For YAML
  public void setTests(List<XmlTest> tests) {
    m_tests = tests;
  }

  
Returns the method selectors.
Returns:
The method selectors./**
   * Returns the method selectors.
   *
   * @return The method selectors.
   */
  public List<XmlMethodSelector> getMethodSelectors() {
    if (m_xmlMethodSelectors != null) {
      return m_xmlMethodSelectors.getMethodSelectors();
    } else {
      // deprecated
      return m_methodSelectors;
    }
  }

  
Sets the method selectors.
Params:
methodSelectors – The method selectors./**
   * Sets the method selectors.
   *
   * @param methodSelectors The method selectors.
   */
  public void setMethodSelectors(List<XmlMethodSelector> methodSelectors) {
    m_methodSelectors = Lists.newArrayList(methodSelectors);
  }

  
Updates the list of parameters that apply to this XML suite. This method should be invoked any
time there is a change in the state of this suite that would affect the parameter list.

NOTE: Currently being invoked after a parent suite is added or if parameters for this suite are
updated.
/**
   * Updates the list of parameters that apply to this XML suite. This method should be invoked any
   * time there is a change in the state of this suite that would affect the parameter list.<br>
   * NOTE: Currently being invoked after a parent suite is added or if parameters for this suite are
   * updated.
   */
  private void updateParameters() {
    /*
     * Whatever parameters are set by a user or via XML should be updated
     * using parameters from the parent suite, if it exists. Parameters from this
     * suite override the same named parameters from the parent suite.
     */
    if (m_parentSuite != null) {
      Set<String> keySet = m_parentSuite.getParameters().keySet();
      for (String name : keySet) {
        if (!m_parameters.containsKey(name)) {
          m_parameters.put(name, m_parentSuite.getParameter(name));
        }
      }
    }
  }

  
Sets parameters.
Params:
parameters – The parameters./**
   * Sets parameters.
   *
   * @param parameters The parameters.
   */
  public void setParameters(Map<String, String> parameters) {
    m_parameters = parameters;
    updateParameters();
  }

  
Returns:
the parameters that apply to tests in this suite.

The set of parameters for a suite is appended with parameters from the parent suite. Also, parameters
from this suite override the same named parameters from the parent suite./**
   * @return the parameters that apply to tests in this suite.<br>
   * The set of parameters for a suite is appended with parameters from the parent suite. Also, parameters
   * from this suite override the same named parameters from the parent suite.
   */
  public Map<String, String> getParameters() {
    return m_parameters;
  }

  
Returns:
The parameters defined in this suite and all its XmlTests./** @return The parameters defined in this suite and all its XmlTests. */
  public Map<String, String> getAllParameters() {
    Map<String, String> result = Maps.newHashMap();
    for (Map.Entry<String, String> entry : m_parameters.entrySet()) {
      result.put(entry.getKey(), entry.getValue());
    }

    for (XmlTest test : getTests()) {
      Map<String, String> tp = test.getLocalParameters();
      for (Map.Entry<String, String> entry : tp.entrySet()) {
        result.put(entry.getKey(), entry.getValue());
      }
    }

    return result;
  }

  
Returns the parameter defined in this suite only.
Params:
name – The parameter name.
Returns:
The parameter defined in this suite only./**
   * Returns the parameter defined in this suite only.
   *
   * @param name The parameter name.
   * @return The parameter defined in this suite only.
   */
  public String getParameter(String name) {
    return m_parameters.get(name);
  }

  
Returns:
The threadCount./** @return The threadCount. */
  public int getThreadCount() {
    return m_threadCount;
  }

  
Set the thread count.
Params:
threadCount – The thread count to set./**
   * Set the thread count.
   *
   * @param threadCount The thread count to set.
   */
  public void setThreadCount(int threadCount) {
    m_threadCount = threadCount;
  }

  
Returns:
The JUnit compatibility flag./** @return The JUnit compatibility flag. */
  public Boolean isJUnit() {
    return m_isJUnit;
  }

  
Sets the JUnit compatibility flag.
Params:
isJUnit – The JUnit compatibility flag./**
   * Sets the JUnit compatibility flag.
   *
   * @param isJUnit The JUnit compatibility flag.
   */
  public void setJUnit(Boolean isJUnit) {
    m_isJUnit = isJUnit;
  }

  // For YAML
  public void setJunit(Boolean j) {
    setJUnit(j);
  }

  public Boolean skipFailedInvocationCounts() {
    return m_skipFailedInvocationCounts;
  }

  public void setSkipFailedInvocationCounts(boolean skip) {
    m_skipFailedInvocationCounts = skip;
  }

  
Sets the XML packages.
Params:
packages – The XML packages./**
   * Sets the XML packages.
   *
   * @param packages The XML packages.
   */
  public void setXmlPackages(List<XmlPackage> packages) {
    m_xmlPackages = Lists.newArrayList(packages);
  }

  
Returns the XML packages.
Returns:
The XML packages./**
   * Returns the XML packages.
   *
   * @return The XML packages.
   */
  public List<XmlPackage> getXmlPackages() {
    return m_xmlPackages;
  }

  // For YAML
  public List<XmlPackage> getPackages() {
    return getXmlPackages();
  }

  public void setMethodSelectors(XmlMethodSelectors xms) {
    m_xmlMethodSelectors = xms;
  }

  // For YAML
  public void setPackages(List<XmlPackage> packages) {
    setXmlPackages(packages);
  }

  
Returns:
A String representation of this XML suite./** @return A String representation of this XML suite. */
  public String toXml() {
    return XmlWeaver.asXml(this);
  }

  
Returns:
- The list of listener names that are local to the current <suite>./** @return - The list of listener names that are local to the current &lt;suite&gt;. */
  public List<String> getLocalListeners() {
    return m_listeners;
  }

  public void setXmlMethodSelectors(XmlMethodSelectors xms) {
    m_xmlMethodSelectors = xms;
  }

  public XmlMethodSelectors getXmlMethodSelectors() {
    return m_xmlMethodSelectors;
  }

  
{@inheritDoc} /** {@inheritDoc} */
  @Override
  public String toString() {
    StringBuilder result = new StringBuilder("[Suite: \"").append(m_name).append("\" ");

    for (XmlTest t : m_tests) {
      result.append("  ").append(t.toString()).append(' ');
    }

    for (XmlMethodSelector ms : m_methodSelectors) {
      result.append(" methodSelector:").append(ms);
    }

    result.append(']');

    return result.toString();
  }

  
{@inheritDoc} Note that this is not a full clone: XmlTest children are not cloned by this
method.
/**
   * {@inheritDoc} Note that this is not a full clone: XmlTest children are not cloned by this
   * method.
   */
  @Override
  public Object clone() {
    XmlSuite result = shallowCopy();
    result.setExcludedGroups(getExcludedGroups());
    result.setIncludedGroups(getIncludedGroups());
    result.setGroupByInstances(getGroupByInstances());
    result.setGroups(getGroups());
    result.setMethodSelectors(getXmlMethodSelectors());
    result.setPackages(getPackages());
    result.setParentSuite(getParentSuite());
    result.setPreserveOrder(getPreserveOrder());
    result.setSuiteFiles(getSuiteFiles());
    result.setTests(getTests());
    result.setXmlMethodSelectors(getXmlMethodSelectors());
    return result;
  }

  
This method returns a shallow cloned version. XmlTests are not copied by this method. 
Returns:
- A shallow copied version of XmlSuite./**
   * This method returns a shallow cloned version. {@link XmlTest}s are not copied by this method.
   *
   * @return - A shallow copied version of {@link XmlSuite}.
   */
  public XmlSuite shallowCopy() {
    XmlSuite result = new XmlSuite();
    result.setName(getName());
    result.setFileName(getFileName());
    result.setListeners(getListeners());
    result.setParallel(getParallel());
    result.setParentModule(getParentModule());
    result.setGuiceStage(getGuiceStage());
    result.setConfigFailurePolicy(getConfigFailurePolicy());
    result.setThreadCount(getThreadCount());
    result.setDataProviderThreadCount(getDataProviderThreadCount());
    result.setParameters(getParameters());
    result.setVerbose(getVerbose());
    result.setXmlPackages(getXmlPackages());
    result.setMethodSelectors(getMethodSelectors());
    result.setJUnit(isJUnit()); // TESTNG-141
    result.setSkipFailedInvocationCounts(skipFailedInvocationCounts());
    result.setObjectFactory(getObjectFactory());
    result.setAllowReturnValues(getAllowReturnValues());
    result.setTimeOut(getTimeOut());
    return result;
  }

  
Sets the timeout.
Params:
timeOut – The timeout./**
   * Sets the timeout.
   *
   * @param timeOut The timeout.
   */
  public void setTimeOut(String timeOut) {
    m_timeOut = timeOut;
  }

  
Returns the timeout.
Returns:
The timeout./**
   * Returns the timeout.
   *
   * @return The timeout.
   */
  public String getTimeOut() {
    return m_timeOut;
  }

  
Returns the timeout as a long value specifying the default value to be used if no timeout was
specified.
Params:
def – The default value to be used if no timeout was specified.
Returns:
The timeout as a long value specifying the default value to be used if no timeout was
    specified./**
   * Returns the timeout as a long value specifying the default value to be used if no timeout was
   * specified.
   *
   * @param def The default value to be used if no timeout was specified.
   * @return The timeout as a long value specifying the default value to be used if no timeout was
   *     specified.
   */
  public long getTimeOut(long def) {
    long result = def;
    if (m_timeOut != null) {
      result = Long.parseLong(m_timeOut);
    }

    return result;
  }

  
Sets the suite files.
Params:
files – The suite files./**
   * Sets the suite files.
   *
   * @param files The suite files.
   */
  public void setSuiteFiles(List<String> files) {
    m_suiteFiles = files;
  }

  
Returns the suite files.
Returns:
The suite files./**
   * Returns the suite files.
   *
   * @return The suite files.
   */
  public List<String> getSuiteFiles() {
    return m_suiteFiles;
  }

  public void setListeners(List<String> listeners) {
    m_listeners = listeners;
  }

  public List<String> getListeners() {
    if (m_parentSuite != null) {
      List<String> listeners = m_parentSuite.getListeners();
      for (String listener : listeners) {
        if (!m_listeners.contains(listener)) {
          m_listeners.add(listener);
        }
      }
    }
    return m_listeners;
  }

  public void setDataProviderThreadCount(int count) {
    m_dataProviderThreadCount = count;
  }

  public int getDataProviderThreadCount() {
    String s = RuntimeBehavior.getDefaultDataProviderThreadCount();
    try {
      if (!s.trim().isEmpty()) {
        return Integer.parseInt(s);
      }
    } catch (NumberFormatException nfe) {
      System.err.println("Parsing System property 'dataproviderthreadcount': " + nfe);
    }
    return m_dataProviderThreadCount;
  }

  public void setParentSuite(XmlSuite parentSuite) {
    m_parentSuite = parentSuite;
    updateParameters();
  }

  public XmlSuite getParentSuite() {
    return m_parentSuite;
  }

  public List<XmlSuite> getChildSuites() {
    return m_childSuites;
  }

  @Override
  public int hashCode() {
    final int prime = 31;
    int result = 1;
    result =
        prime * result + ((m_configFailurePolicy == null) ? 0 : m_configFailurePolicy.hashCode());
    result = prime * result + m_dataProviderThreadCount;
    result = prime * result + ((m_fileName == null) ? 0 : m_fileName.hashCode());
    result = prime * result + ((m_isJUnit == null) ? 0 : m_isJUnit.hashCode());
    result = prime * result + ((m_listeners == null) ? 0 : m_listeners.hashCode());

    result = prime * result + ((m_methodSelectors == null) ? 0 : m_methodSelectors.hashCode());
    result = prime * result + ((m_name == null) ? 0 : m_name.hashCode());
    result = prime * result + ((m_objectFactory == null) ? 0 : m_objectFactory.hashCode());
    result = prime * result + ((m_parallel == null) ? 0 : m_parallel.hashCode());
    //    result = prime * result
    //        + ((m_parameters == null) ? 0 : m_parameters.hashCode());
    //      result = prime * result
    //          + ((m_parentSuite == null) ? 0 : m_parentSuite.hashCode());
    result =
        prime * result
            + ((m_skipFailedInvocationCounts == null)
                ? 0
                : m_skipFailedInvocationCounts.hashCode());
    result = prime * result + ((m_suiteFiles == null) ? 0 : m_suiteFiles.hashCode());
    result = prime * result + ((m_test == null) ? 0 : m_test.hashCode());
    result = prime * result + ((m_tests == null) ? 0 : m_tests.hashCode());
    result = prime * result + m_threadCount;
    result = prime * result + ((m_timeOut == null) ? 0 : m_timeOut.hashCode());
    result = prime * result + ((m_verbose == null) ? 0 : m_verbose.hashCode());
    result = prime * result + ((m_xmlPackages == null) ? 0 : m_xmlPackages.hashCode());
    return result;
  }

  
Used to debug equals() bugs. /** Used to debug equals() bugs. */
  static boolean f() {
    return false;
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return f();
    }
    if (getClass() != obj.getClass()) {
      return f();
    }
    XmlSuite other = (XmlSuite) obj;
    //      if (m_childSuites == null) {
    //        if (other.m_childSuites != null)
    //          return f();
    //      } else if (!m_childSuites.equals(other.m_childSuites))
    //        return f();
    if (m_configFailurePolicy == null) {
      if (other.m_configFailurePolicy != null) {
        return f();
      }
    } else if (!m_configFailurePolicy.equals(other.m_configFailurePolicy)) {
      return f();
    }
    if (m_dataProviderThreadCount != other.m_dataProviderThreadCount) {
      return f();
    }
    if (m_isJUnit == null) {
      if (other.m_isJUnit != null) {
        return f();
      }
    } else if (!m_isJUnit.equals(other.m_isJUnit)) {
      return f();
    }
    if (m_listeners == null) {
      if (other.m_listeners != null) {
        return f();
      }
    } else if (!m_listeners.equals(other.m_listeners)) {
      return f();
    }
    if (m_methodSelectors == null) {
      if (other.m_methodSelectors != null) {
        return f();
      }
    } else if (!m_methodSelectors.equals(other.m_methodSelectors)) {
      return f();
    }
    if (m_name == null) {
      if (other.m_name != null) {
        return f();
      }
    } else if (!m_name.equals(other.m_name)) {
      return f();
    }
    if (m_objectFactory == null) {
      if (other.m_objectFactory != null) {
        return f();
      }
    } else if (!m_objectFactory.equals(other.m_objectFactory)) {
      return f();
    }
    if (m_parallel == null) {
      if (other.m_parallel != null) {
        return f();
      }
    } else if (!m_parallel.equals(other.m_parallel)) {
      return f();
    }
    //    if (m_parameters == null) {
    //      if (other.m_parameters != null) {
    //        return f();
    //      }
    //    } else if (!m_parameters.equals(other.m_parameters)) {
    //      return f();
    //    }
    //      if (m_parentSuite == null) {
    //        if (other.m_parentSuite != null)
    //          return f();
    //      } else if (!m_parentSuite.equals(other.m_parentSuite))
    //        return f();
    if (m_skipFailedInvocationCounts == null) {
      if (other.m_skipFailedInvocationCounts != null) return f();
    } else if (!m_skipFailedInvocationCounts.equals(other.m_skipFailedInvocationCounts)) return f();
    if (m_suiteFiles == null) {
      if (other.m_suiteFiles != null) return f();
    } else if (!m_suiteFiles.equals(other.m_suiteFiles)) return f();
    if (m_test == null) {
      if (other.m_test != null) return f();
    } else if (!m_test.equals(other.m_test)) return f();
    if (m_tests == null) {
      if (other.m_tests != null) return f();
    } else if (!m_tests.equals(other.m_tests)) return f();
    if (m_threadCount != other.m_threadCount) return f();
    if (m_timeOut == null) {
      if (other.m_timeOut != null) return f();
    } else if (!m_timeOut.equals(other.m_timeOut)) return f();
    if (m_verbose == null) {
      if (other.m_verbose != null) return f();
    } else if (!m_verbose.equals(other.m_verbose)) return f();
    if (m_xmlPackages == null) {
      if (other.m_xmlPackages != null) return f();
    } else if (!m_xmlPackages.equals(other.m_xmlPackages)) return f();
    return true;
  }

  
Params:
f – The String value
Deprecated:
Use setPreserveOrder(Boolean) instead/**
   * @param f The String value
   * @deprecated Use {@link #setPreserveOrder(Boolean)} instead
   */
  @Deprecated
  public void setPreserveOrder(String f) {
    setPreserveOrder(Boolean.valueOf(f));
  }

  public void setPreserveOrder(Boolean f) {
    m_preserveOrder = f;
  }

  public Boolean getPreserveOrder() {
    return m_preserveOrder;
  }

  
Returns:
Returns the includedGroups. Note: do not modify the returned value, use addIncludedGroup(String)./**
   * @return Returns the includedGroups. Note: do not modify the returned value, use {@link
   *     #addIncludedGroup(String)}.
   */
  public List<String> getIncludedGroups() {
    if (m_parentSuite != null) {
      return m_parentSuite.getIncludedGroups();
    } else if (m_xmlGroups != null && (m_xmlGroups.getRun() != null)) {
      return m_xmlGroups.getRun().getIncludes();
    } else {
      // deprecated
      return m_includedGroups;
    }
  }

  public void addIncludedGroup(String g) {
    m_includedGroups.add(g);
  }

  
Params:
g – - The list of groups to include./** @param g - The list of groups to include. */
  public void setIncludedGroups(List<String> g) {
    m_includedGroups = g;
  }

  
Params:
g – The excludedGrousps to set./** @param g The excludedGrousps to set. */
  public void setExcludedGroups(List<String> g) {
    m_excludedGroups = g;
  }

  
Returns:
Returns the excludedGroups. Note: do not modify the returned value, use addExcludedGroup(String)./**
   * @return Returns the excludedGroups. Note: do not modify the returned value, use {@link
   *     #addExcludedGroup(String)}.
   */
  public List<String> getExcludedGroups() {
    if (m_parentSuite != null) {
      return m_parentSuite.getExcludedGroups();
    } else if (m_xmlGroups != null && (m_xmlGroups.getRun() != null)) {
      return m_xmlGroups.getRun().getExcludes();
    } else {
      return m_excludedGroups;
    }
  }

  public void addExcludedGroup(String g) {
    m_excludedGroups.add(g);
  }

  public Boolean getGroupByInstances() {
    return m_groupByInstances;
  }

  public void setGroupByInstances(boolean f) {
    m_groupByInstances = f;
  }

  public void addListener(String listener) {
    m_listeners.add(listener);
  }

  public Boolean getAllowReturnValues() {
    return m_allowReturnValues;
  }

  public void setAllowReturnValues(Boolean allowReturnValues) {
    m_allowReturnValues = allowReturnValues;
  }

  private XmlGroups m_xmlGroups;

  public void setGroups(XmlGroups xmlGroups) {
    m_xmlGroups = xmlGroups;
  }

  public void onParameterElement(String name, String value) {
    getParameters().put(name, value);
  }

  public void onListenerElement(String className) {
    addListener(className);
  }

  public void onSuiteFilesElement(String path) {
    getSuiteFiles().add(path);
  }

  public void onPackagesElement(String name) {
    getPackages().add(new XmlPackage(name));
  }

  public void onMethodSelectorElement(String language, String name, String priority) {
    System.out.println("Language:" + language);
  }

  public XmlGroups getGroups() {
    return m_xmlGroups;
  }

  public void addTest(XmlTest test) {
    getTests().add(test);
  }

  public Collection<String> getPackageNames() {
    List<String> result = Lists.newArrayList();
    for (XmlPackage p : getPackages()) {
      result.add(p.getName());
    }
    return result;
  }
}