com.goldencode.p2j.testengine

Class NoopDescriptor

java.lang.Object

com.goldencode.p2j.testengine.NoopDescriptor

All Implemented Interfaces:

Printable, java.io.Externalizable, java.io.Serializable, org.junit.platform.engine.support.hierarchical.Node<FWDEngineExecutionContext>, org.junit.platform.engine.TestDescriptor

Direct Known Subclasses:

AbstractFWDTestDescriptor

public class NoopDescriptor
extends java.lang.Object
implements org.junit.platform.engine.support.hierarchical.Node<FWDEngineExecutionContext>, org.junit.platform.engine.TestDescriptor, Printable, java.io.Externalizable

The NoopDescriptor does nothing.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.junit.platform.engine.support.hierarchical.Node

org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor, org.junit.platform.engine.support.hierarchical.Node.ExecutionMode, org.junit.platform.engine.support.hierarchical.Node.Invocation<C extends org.junit.platform.engine.support.hierarchical.EngineExecutionContext>, org.junit.platform.engine.support.hierarchical.Node.SkipResult

Nested classes/interfaces inherited from interface org.junit.platform.engine.TestDescriptor

org.junit.platform.engine.TestDescriptor.Type, org.junit.platform.engine.TestDescriptor.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	displayName This descriptor display name
protected org.junit.platform.engine.TestDescriptor	parent The parent descriptor or null if this is the root (test engine) descriptor
private org.junit.platform.engine.UniqueId	uniqueId The descriptor unique ID

Constructor Summary

Constructors

Constructor and Description
NoopDescriptor(org.junit.platform.engine.UniqueId uniqueId, java.lang.String displayName) The constructor.

Method Summary

Modifier and Type	Method and Description
void	addChild(org.junit.platform.engine.TestDescriptor descriptor) Add a child to this descriptor.
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
FWDEngineExecutionContext	execute(FWDEngineExecutionContext context, org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor dynamicTestExecutor) Execute the behavior of this node.
java.util.Optional<? extends org.junit.platform.engine.TestDescriptor>	findByUniqueId(org.junit.platform.engine.UniqueId id) Find the descriptor with the supplied unique ID.
java.util.Set<? extends org.junit.platform.engine.TestDescriptor>	getChildren() Get the immutable set of children of this descriptor.
java.lang.String	getDisplayName() Get the display name for this descriptor.
java.util.Optional<org.junit.platform.engine.TestDescriptor>	getParent() Get the parent of this descriptor, if available.
java.util.Optional<org.junit.platform.engine.TestSource>	getSource() Get the source of the test or container described by this descriptor, if available.
java.util.Set<org.junit.platform.engine.TestTag>	getTags() Get the set of tags associated with this descriptor.
org.junit.platform.engine.TestDescriptor.Type	getType() Determine the TestDescriptor.Type of this descriptor.
org.junit.platform.engine.UniqueId	getUniqueId() Get the unique identifier (UID) for this descriptor.
int	hashCode() Returns a hash code value for the object.
void	print(PrintHelper printer) Print all class-specific fields.
void	readExternal(java.io.ObjectInput in) The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
void	removeChild(org.junit.platform.engine.TestDescriptor descriptor) Remove a child from this descriptor.
void	removeFromHierarchy() Remove this non-root descriptor from its parent and remove all the children from this descriptor.
void	setParent(org.junit.platform.engine.TestDescriptor parent) Set the parent of this descriptor.
java.lang.String	toString() Returns a string representation of the object.
void	writeExternal(java.io.ObjectOutput out) The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.junit.platform.engine.support.hierarchical.Node

after, around, before, cleanUp, getExclusiveResources, getExecutionMode, nodeFinished, nodeSkipped, prepare, shouldBeSkipped

Methods inherited from interface org.junit.platform.engine.TestDescriptor

accept, containsTests, getAncestors, getDescendants, getLegacyReportingName, isContainer, isRoot, isTest, mayRegisterTests, prune

Methods inherited from interface com.goldencode.util.Printable

asString

Field Detail

displayName

private java.lang.String displayName

This descriptor display name

uniqueId

private org.junit.platform.engine.UniqueId uniqueId

The descriptor unique ID

parent

protected org.junit.platform.engine.TestDescriptor parent

The parent descriptor or null if this is the root (test engine) descriptor

Constructor Detail

NoopDescriptor

public NoopDescriptor(org.junit.platform.engine.UniqueId uniqueId,
                      java.lang.String displayName)

The constructor.

Parameters:

uniqueId - the descriptor unique ID

displayName - the descriptor display name

Method Detail

addChild

public void addChild(org.junit.platform.engine.TestDescriptor descriptor)

Add a child to this descriptor.

Specified by:

addChild in interface org.junit.platform.engine.TestDescriptor

Parameters:

descriptor - the child to add to this descriptor; never null

equals

public final boolean equals(java.lang.Object obj)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the reference object with which to compare.

Returns:

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

See Also:

hashCode(), HashMap

execute

public FWDEngineExecutionContext execute(FWDEngineExecutionContext context,
                                         org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor dynamicTestExecutor)
                                  throws java.lang.Exception

Execute the behavior of this node.

Containers typically do not implement this method since the HierarchicalTestEngine handles execution of their children.

The supplied dynamicTestExecutor may be used to submit additional dynamic tests for immediate execution.

The default implementation returns the supplied context unmodified.

Specified by:

execute in interface org.junit.platform.engine.support.hierarchical.Node<FWDEngineExecutionContext>

Parameters:

context - the context to execute in

dynamicTestExecutor - the executor to submit dynamic tests to

Returns:

the new context to be used for children of this node and for the after behavior of the parent of this node, if any

Throws:

java.lang.Exception

See Also:

Node.before(C), Node.after(C)

findByUniqueId

public java.util.Optional<? extends org.junit.platform.engine.TestDescriptor> findByUniqueId(org.junit.platform.engine.UniqueId id)

Find the descriptor with the supplied unique ID.

The search algorithm begins with this descriptor and then searches through its descendants.

Specified by:

findByUniqueId in interface org.junit.platform.engine.TestDescriptor

Parameters:

id - the UniqueId to search for; never null

getChildren

public java.util.Set<? extends org.junit.platform.engine.TestDescriptor> getChildren()

Get the immutable set of children of this descriptor.

Specified by:

getChildren in interface org.junit.platform.engine.TestDescriptor

Returns:

the set of children of this descriptor; neither null nor mutable, but potentially empty

See Also:

TestDescriptor.getDescendants()

getDisplayName

public java.lang.String getDisplayName()

Get the display name for this descriptor.

A display name is a human-readable name for a test or container that is typically used for test reporting in IDEs and build tools. Display names may contain spaces, special characters, and emoji, and the format may be customized by TestEngines or potentially by end users as well. Consequently, display names should never be parsed; rather, they should be used for display purposes only.

Specified by:

getDisplayName in interface org.junit.platform.engine.TestDescriptor

Returns:

the display name for this descriptor; never null or blank

See Also:

getSource()

getParent

public java.util.Optional<org.junit.platform.engine.TestDescriptor> getParent()

Get the parent of this descriptor, if available.

Specified by:

getParent in interface org.junit.platform.engine.TestDescriptor

getSource

public java.util.Optional<org.junit.platform.engine.TestSource> getSource()

Get the source of the test or container described by this descriptor, if available.

Specified by:

getSource in interface org.junit.platform.engine.TestDescriptor

See Also:

TestSource

getTags

public java.util.Set<org.junit.platform.engine.TestTag> getTags()

Get the set of tags associated with this descriptor.

Specified by:

getTags in interface org.junit.platform.engine.TestDescriptor

Returns:

the set of tags associated with this descriptor; never null but potentially empty

See Also:

TestTag

getType

public org.junit.platform.engine.TestDescriptor.Type getType()

Determine the TestDescriptor.Type of this descriptor.

Specified by:

getType in interface org.junit.platform.engine.TestDescriptor

Returns:

the descriptor type; never null.

See Also:

TestDescriptor.isContainer(), TestDescriptor.isTest()

getUniqueId

public final org.junit.platform.engine.UniqueId getUniqueId()

Get the unique identifier (UID) for this descriptor.

Uniqueness must be guaranteed across an entire test plan, regardless of how many engines are used behind the scenes.

Specified by:

getUniqueId in interface org.junit.platform.engine.TestDescriptor

Returns:

the UniqueId for this descriptor; never null

hashCode

public final int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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(Object) 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 Object.equals(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

print

public void print(PrintHelper printer)

Print all class-specific fields.

Specified by:

print in interface Printable

Parameters:

printer - the string printer to print into

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - the stream to read data from in order to restore the object

Throws:

java.io.IOException - if I/O errors occur

java.lang.ClassNotFoundException - If the class for an object being restored cannot be found.

removeChild

public void removeChild(org.junit.platform.engine.TestDescriptor descriptor)

Remove a child from this descriptor.

Specified by:

removeChild in interface org.junit.platform.engine.TestDescriptor

Parameters:

descriptor - the child to remove from this descriptor; never null

removeFromHierarchy

public void removeFromHierarchy()

Remove this non-root descriptor from its parent and remove all the children from this descriptor.

If this method is invoked on a root descriptor, this method must throw a JUnitException explaining that a root cannot be removed from the hierarchy.

Specified by:

removeFromHierarchy in interface org.junit.platform.engine.TestDescriptor

setParent

public void setParent(org.junit.platform.engine.TestDescriptor parent)

Set the parent of this descriptor.

Specified by:

setParent in interface org.junit.platform.engine.TestDescriptor

Parameters:

parent - the new parent of this descriptor; may be null.

toString

public java.lang.String toString()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - the stream to write the object to

Throws:

java.io.IOException - Includes any I/O exceptions that may occur