Top Description Inners Methods
org.testng.internal

public Interface IObject

Known Direct Implementers
org.testng.internal.NoOpTestClass, org.testng.TestClass, org.testng.internal.ClassImpl
Imports
java.util.Arrays, .Objects, .Optional, .UUID

Represents the associations of a class with one or more instances. Relevant with @Factory annotation.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
IObject.IdentifiableArrayObject

A wrapper class that wraps around an array and associates a unique Id that can be used as a key for the array.

public static class
IObject.IdentifiableObject

A wrapper object that associates a unique id to every unique test class object.

Method Summary

Modifier and TypeMethod and Description
public void
addObject(IObject.IdentifiableObject
- The instance that should be added to the list of instances.
instance
)

public static Optional<IObject>

Returns:

- If the incoming object is an instance of IObject then the cast instance is wrapped within Optional else it would be an Optional#empty()
cast
(Object
- The object that should be inspected for its compatibility with IObject.
object
)

public long[]

Returns:

- An array representing the hash codes of the corresponding instances.
getInstanceHashCodes
()

public IObject.IdentifiableObject[]

Returns:

- An array of IdentifiableObject objects
getObjects
(boolean
- true if objects should be created before returning.
create
,
String
- Text that should be prefixed to the error message when there are issues. Can be empty.
errorMsgPrefix
)

Returns all the instances the methods will be invoked upon.

public static long[]

Returns:

- An array representing the hash codes of the corresponding instances.
instanceHashCodes
(Object
- The object that should be inspected for its compatibility with IObject.
object
)

public static IObject.IdentifiableObject[]

Returns:

- An array (can be empty is instance compatibility fails) of IdentifiableObject objects.
objects
(Object
- The object that should be inspected for its compatibility with IObject.
object
,
boolean
- true if objects should be created before returning.
create
)

public static IObject.IdentifiableObject[]

Returns:

- An array (can be empty is instance compatibility fails) of IdentifiableObject objects.
objects
(Object
- The object that should be inspected for its compatibility with IObject.
object
,
boolean
- true if objects should be created before returning.
create
,
String
- Text that should be prefixed to the error message when there are issues. Can be empty.
errorMsgPrefix
)

Method Detail

addObjectback to summary
public void addObject(IObject.IdentifiableObject instance)
Parameters
instance:IObject.IdentifiableObject

- The instance that should be added to the list of instances.

castback to summary
public static Optional<IObject> cast(Object object)
Parameters
object:Object

- The object that should be inspected for its compatibility with IObject.

Returns:Optional<IObject>

- If the incoming object is an instance of IObject then the cast instance is wrapped within Optional else it would be an Optional#empty()

getInstanceHashCodesback to summary
public long[] getInstanceHashCodes()
Returns:long[]

- An array representing the hash codes of the corresponding instances.

getObjectsback to summary
public IObject.IdentifiableObject[] getObjects(boolean create, String errorMsgPrefix)

Returns all the instances the methods will be invoked upon. This will typically be an array of one object in the absence of a @Factory annotation.

Parameters
create:boolean

- true if objects should be created before returning.

errorMsgPrefix:String

- Text that should be prefixed to the error message when there are issues. Can be empty.

Returns:IObject.IdentifiableObject[]

- An array of IdentifiableObject objects

instanceHashCodesback to summary
public static long[] instanceHashCodes(Object object)
Parameters
object:Object

- The object that should be inspected for its compatibility with IObject.

Returns:long[]

- An array representing the hash codes of the corresponding instances.

objectsback to summary
public static IObject.IdentifiableObject[] objects(Object object, boolean create)
Parameters
object:Object

- The object that should be inspected for its compatibility with IObject.

create:boolean

- true if objects should be created before returning.

Returns:IObject.IdentifiableObject[]

- An array (can be empty is instance compatibility fails) of IdentifiableObject objects.

objectsback to summary
public static IObject.IdentifiableObject[] objects(Object object, boolean create, String errorMsgPrefix)
Parameters
object:Object

- The object that should be inspected for its compatibility with IObject.

create:boolean

- true if objects should be created before returning.

errorMsgPrefix:String

- Text that should be prefixed to the error message when there are issues. Can be empty.

Returns:IObject.IdentifiableObject[]

- An array (can be empty is instance compatibility fails) of IdentifiableObject objects.

org.testng.internal back to summary

public Class IObject.IdentifiableArrayObject

extends Object
Class Inheritance

A wrapper class that wraps around an array and associates a unique Id that can be used as a key for the array.

Field Summary

Modifier and TypeField and Description
private final String
private final Object[]

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
object
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

instanceIdback to summary
private final String instanceId
parametersback to summary
private final Object[] parameters

Constructor Detail

IdentifiableArrayObjectback to summary
public IdentifiableArrayObject(Object[] parameters)

Method Detail

equalsback to summary
public boolean equals(Object object)

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
object: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
getInstanceIdback to summary
public String getInstanceId()
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
org.testng.internal back to summary

public Class IObject.IdentifiableObject

extends Object
Class Inheritance

A wrapper object that associates a unique id to every unique test class object.

Field Summary

Modifier and TypeField and Description
private final Object
private final UUID

Constructor Summary

AccessConstructor and Description
public
public
IdentifiableObject(Object instance, UUID instanceId)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
object
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public Object
public UUID
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public static Object
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

instanceback to summary
private final Object instance
instanceIdback to summary
private final UUID instanceId

Constructor Detail

IdentifiableObjectback to summary
public IdentifiableObject(Object instance)
IdentifiableObjectback to summary
public IdentifiableObject(Object instance, UUID instanceId)

Method Detail

equalsback to summary
public boolean equals(Object object)

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
object: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
getInstanceback to summary
public Object getInstance()
getInstanceIdback to summary
public UUID getInstanceId()
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
unwrapback to summary
public static Object unwrap(IObject.IdentifiableObject object)