Top Description Fields Constructors Methods
org.testng.xml

public Class XmlClass

extends Object
implements Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable
Imports
java.util.List, .Map, .Properties, org.testng.TestNGException, org.testng.collections.Lists, .Maps, .Objects, org.testng.internal.ClassHelper, org.testng.reporters.XMLStringBuffer
This class describes the tag <class> in testng.xml.

Field Summary

Modifier and TypeField and Description
private Class<T>
m_class

private List<String>
m_excludedMethods

private List<XmlInclude>
m_includedMethods

private int
m_index

The index of this class in the <test> tag

private boolean
m_loadClasses

True if the classes need to be loaded

private String
m_name

private Map<String, String>
m_parameters

private XmlTest
m_xmlTest

Constructor Summary

AccessConstructor and Description
public
XmlClass()

public
XmlClass(String name)

public
XmlClass(String name, boolean loadClasses)

public
XmlClass(Class<T> cls)

public
XmlClass(Class<T> cls, boolean loadClasses)

public
XmlClass(String className, int index)

public
XmlClass(String className, int index, boolean loadClasses)

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides java.lang.Object.clone.

Clone an XmlClass by copying all its components.
public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public Map<String, String>

Returns:

The parameters defined in this test tag and the tags above it.
getAllParameters()

public List<String>

Returns:

Returns the excludedMethods.
getExcludedMethods()

public List<XmlInclude>

Returns:

Returns the includedMethods.
getIncludedMethods()

public int

Returns:

the value
getIndex()

Note that this attribute does not come from the XML file, it's calculated internally and represents the order in which this class was found in its <test> tag.

public Map<String, String>

Returns:

The parameters defined in this tag, and only this test tag. To retrieve the inherited parameters as well, call getAllParameters().
getLocalParameters()

public String

Returns:

Returns the name.
getName()

public Class<?>

Returns:

Returns the className.
getSupportClass()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
private void
init(String className, Class<T> cls, int index)

private void
init(String className, Class<T> cls, int index, boolean resolveClass)

public static String
listToString(List<Integer> invocationNumbers)

private void
loadClass()

public boolean

Returns:

true if the classes need to be loaded.
loadClasses()

public void
setClass(Class<T>
The className to set.
className)

public void
setExcludedMethods(List<String>
The excludedMethods to set.
excludedMethods)

public void
setIncludedMethods(List<XmlInclude>
The includedMethods to set.
includedMethods)

public void
setIndex(int index)

public void
setName(String
The name to set.
name)

public void
setParameters(Map<String, String> parameters)

public void
setXmlTest(XmlTest test)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public String
toXml(String indent)

Inherited from java.lang.Object:
finalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

m_classback to summary
private Class<T> m_class
m_excludedMethodsback to summary
private List<String> m_excludedMethods
m_includedMethodsback to summary
private List<XmlInclude> m_includedMethods
m_indexback to summary
private int m_index

The index of this class in the <test> tag

m_loadClassesback to summary
private boolean m_loadClasses

True if the classes need to be loaded

m_nameback to summary
private String m_name
m_parametersback to summary
private Map<String, String> m_parameters
m_xmlTestback to summary
private XmlTest m_xmlTest

Constructor Detail

XmlClassback to summary
public XmlClass()
XmlClassback to summary
public XmlClass(String name)
XmlClassback to summary
public XmlClass(String name, boolean loadClasses)
XmlClassback to summary
public XmlClass(Class<T> cls)
XmlClassback to summary
public XmlClass(Class<T> cls, boolean loadClasses)
XmlClassback to summary
public XmlClass(String className, int index)
XmlClassback to summary
public XmlClass(String className, int index, boolean loadClasses)

Method Detail

cloneback to summary
public Object clone()

Overrides java.lang.Object.clone.

Clone an XmlClass by copying all its components.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getAllParametersback to summary
public Map<String, String> getAllParameters()
Returns:Map<String, String>

The parameters defined in this test tag and the tags above it.

getExcludedMethodsback to summary
public List<String> getExcludedMethods()
Returns:List<String>

Returns the excludedMethods.

getIncludedMethodsback to summary
public List<XmlInclude> getIncludedMethods()
Returns:List<XmlInclude>

Returns the includedMethods.

getIndexback to summary
public int getIndex()

Note that this attribute does not come from the XML file, it's calculated internally and represents the order in which this class was found in its <test> tag. It's used to calculate the ordering of the classes when preserve-order is true.

Returns:int

the value

getLocalParametersback to summary
public Map<String, String> getLocalParameters()
Returns:Map<String, String>

The parameters defined in this tag, and only this test tag. To retrieve the inherited parameters as well, call getAllParameters().

getNameback to summary
public String getName()
Returns:String

Returns the name.

getSupportClassback to summary
public Class<?> getSupportClass()
Returns:Class<?>

Returns the className.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
initback to summary
private void init(String className, Class<T> cls, int index)
initback to summary
private void init(String className, Class<T> cls, int index, boolean resolveClass)
listToStringback to summary
public static String listToString(List<Integer> invocationNumbers)
loadClassback to summary
private void loadClass()
loadClassesback to summary
public boolean loadClasses()
Returns:boolean

true if the classes need to be loaded.

setClassback to summary
public void setClass(Class<T> className)
Parameters
className:Class<T>

The className to set.

setExcludedMethodsback to summary
public void setExcludedMethods(List<String> excludedMethods)
Parameters
excludedMethods:List<String>

The excludedMethods to set.

setIncludedMethodsback to summary
public void setIncludedMethods(List<XmlInclude> includedMethods)
Parameters
includedMethods:List<XmlInclude>

The includedMethods to set.

setIndexback to summary
public void setIndex(int index)
setNameback to summary
public void setName(String name)
Parameters
name:String

The name to set.

setParametersback to summary
public void setParameters(Map<String, String> parameters)
setXmlTestback to summary
public void setXmlTest(XmlTest test)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override
toXmlback to summary
public String toXml(String indent)