AbstractFWDTestDescriptor (P2J - Progress 4GL to Java Conversion and Runtime)

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.util.Set<org.junit.platform.engine.TestTag> tags
The tags
- Fields inherited from class com.goldencode.p2j.testengine.NoopDescriptor
  parent

Fields
Modifier and Type	Field and Description
`private java.util.Set<org.junit.platform.engine.TestTag>`	`tags` The tags

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractFWDTestDescriptor()` Default constructor.
	`AbstractFWDTestDescriptor(org.junit.platform.engine.UniqueId uniqueId, java.lang.String displayName, java.util.Set<org.junit.platform.engine.TestTag> tags)` The constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`after(FWDEngineExecutionContext context)` Execute the after behavior of this node.
`void`	`afterImpl()` Execute the after behavior of this node implementation.
`FWDEngineExecutionContext`	`before(FWDEngineExecutionContext context)` Execute the before behavior of this node.
`void`	`beforeImpl()` Execute the before behavior of this node implementation.
`protected void`	`callLFMethodsImpl(java.util.List<java.lang.reflect.Method> methods)` Convenience method to execute all of life-cycle methods of a kind.
`protected BaseDataType`	`callMethodImpl(java.lang.reflect.Method method, CallParameter[] parameterList)` Execute list of methods implementation, collect the result.
`protected BaseDataType`	`callMethodImpl(java.lang.reflect.Method method, java.lang.Object o, CallParameter[] parameters)` Execute a method.
`protected void`	`checkInstance(handle h)` Throw error if the procedure instance is not valid.
`void`	`cleanUp(FWDEngineExecutionContext context)` Clean up the supplied `context` after execution.
`void`	`cleanUpImpl()` Clean up the supplied `context` after execution implementation.
`FWDEngineExecutionContext`	`execute(FWDEngineExecutionContext context, org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor dynamicTestExecutor)` Execute the behavior of this node.
`void`	`executeImpl()` Execute the implementation behavior of this node.
`java.util.Set<org.junit.platform.engine.TestTag>`	`getTags()` Get the set of tags associated with this descriptor.
`protected static java.util.Set<org.junit.platform.engine.TestTag>`	`getTags(java.lang.reflect.AnnotatedElement o)` Extract set of `TestTag` from tag-related annotations.
`protected java.lang.Object`	`getTestObject()` Get test object.
`FWDEngineExecutionContext`	`prepare(FWDEngineExecutionContext context)` Prepare the supplied `context` prior to execution.
`void`	`prepareImpl()` Prepare the supplied `context` prior to execution implementation.
`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.
`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 com.goldencode.p2j.testengine.NoopDescriptor
addChild, equals, findByUniqueId, getChildren, getDisplayName, getParent, getSource, getType, getUniqueId, hashCode, print, removeChild, removeFromHierarchy, setParent

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
around, getExclusiveResources, getExecutionMode, nodeFinished, nodeSkipped, 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
  - tags
```
private java.util.Set<org.junit.platform.engine.TestTag> tags
```
    The tags
- Constructor Detail
  - AbstractFWDTestDescriptor
```
public AbstractFWDTestDescriptor(org.junit.platform.engine.UniqueId uniqueId,
                                 java.lang.String displayName,
                                 java.util.Set<org.junit.platform.engine.TestTag> tags)
```
    The constructor.
    
    Parameters:
    
    uniqueId - the descriptor unique ID
    
    displayName - the descriptor display name
    
    tags - the tag set
  - AbstractFWDTestDescriptor
```
protected AbstractFWDTestDescriptor()
```
    Default constructor. Must be used internally for serialization only.
- Method Detail
  - getTags
```
protected static final java.util.Set<org.junit.platform.engine.TestTag> getTags(java.lang.reflect.AnnotatedElement o)
```
    Extract set of TestTag from tag-related annotations.
    
    Parameters:
    
    o - the source of tag annotations
    
    Returns:
    
    see above
  - after
```
public void after(FWDEngineExecutionContext context)
           throws ErrorConditionException,
                  org.opentest4j.AssertionFailedError
```
    Execute the after behavior of this node.
    This method will be called once after execution of this node.
    
    Parameters:
    
    context - the context to execute in
    
    Throws:
    
    ErrorConditionException
    
    org.opentest4j.AssertionFailedError
  - afterImpl
```
public void afterImpl()
               throws ErrorConditionException
```
    Execute the after behavior of this node implementation.
    This method will be called once after execution of this node.
    
    Throws:
    
    ErrorConditionException - remote code may throw this
  - before
```
public FWDEngineExecutionContext before(FWDEngineExecutionContext context)
                                 throws ErrorConditionException,
                                        org.opentest4j.AssertionFailedError
```
    Execute the before behavior of this node.
    This method will be called once before execution of this node.
    
    Parameters:
    
    context - the context to execute in
    
    Returns:
    
    the new context to be used for children of this node; never null
    
    Throws:
    
    ErrorConditionException
    
    org.opentest4j.AssertionFailedError
  - beforeImpl
```
public void beforeImpl()
                throws ErrorConditionException
```
    Execute the before behavior of this node implementation.
    This method will be called once before execution of this node.
    
    Throws:
    
    ErrorConditionException - remote code may throw this
  - cleanUp
```
public void cleanUp(FWDEngineExecutionContext context)
             throws ErrorConditionException,
                    org.opentest4j.AssertionFailedError
```
    Clean up the supplied context after execution.
    Reset the test class instance.
    
    Parameters:
    
    context - the context to execute in
    
    Throws:
    
    ErrorConditionException
    
    org.opentest4j.AssertionFailedError
    
    See Also:
    
    prepare(com.goldencode.p2j.testengine.FWDEngineExecutionContext)
  - cleanUpImpl
```
public void cleanUpImpl()
                 throws ErrorConditionException
```
    Clean up the supplied context after execution implementation.
    Reset the test class instance.
    
    Throws:
    
    ErrorConditionException - remote code may throw this
    
    See Also:
    
    prepare(com.goldencode.p2j.testengine.FWDEngineExecutionContext)
  - execute
```
public FWDEngineExecutionContext execute(FWDEngineExecutionContext context,
                                         org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor dynamicTestExecutor)
                                  throws ErrorConditionException,
                                         org.opentest4j.AssertionFailedError
```
    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.
    
    Specified by:
    
    execute in interface org.junit.platform.engine.support.hierarchical.Node<FWDEngineExecutionContext>
    
    Overrides:
    
    execute in class NoopDescriptor
    
    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:
    
    ErrorConditionException
    
    org.opentest4j.AssertionFailedError
    
    See Also:
    
    Node.before(C), Node.after(C)
  - executeImpl
```
public void executeImpl()
                 throws ErrorConditionException
```
    Execute the implementation behavior of this node.
    
    Throws:
    
    ErrorConditionException - remote code may throw this
  - 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
    
    Overrides:
    
    getTags in class NoopDescriptor
    
    Returns:
    
    the set of tags associated with this descriptor; never null but potentially empty
    
    See Also:
    
    TestTag
  - prepare
```
public FWDEngineExecutionContext prepare(FWDEngineExecutionContext context)
                                  throws ErrorConditionException,
                                         org.opentest4j.AssertionFailedError
```
    Prepare the supplied context prior to execution.
    Create test class instance.
    
    Throws:
    
    ErrorConditionException
    
    org.opentest4j.AssertionFailedError
    
    See Also:
    
    cleanUp(com.goldencode.p2j.testengine.FWDEngineExecutionContext)
  - prepareImpl
```
public void prepareImpl()
                 throws ErrorConditionException
```
    Prepare the supplied context prior to execution implementation.
    
    Throws:
    
    ErrorConditionException - remote code may throw this
    
    org.opentest4j.AssertionFailedError - legacy errors are converted to this exception
    
    See Also:
    
    cleanUpImpl()
  - 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
    
    Overrides:
    
    readExternal in class NoopDescriptor
    
    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.
  - 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 NoopDescriptor
    
    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
    
    Overrides:
    
    writeExternal in class NoopDescriptor
    
    Parameters:
    
    out - the stream to write the object to
    
    Throws:
    
    java.io.IOException - Includes any I/O exceptions that may occur
  - callLFMethodsImpl
```
protected final void callLFMethodsImpl(java.util.List<java.lang.reflect.Method> methods)
                                throws ErrorConditionException
```
    Convenience method to execute all of life-cycle methods of a kind. All methods assumed having no parameters and return VOID.
    
    Parameters:
    
    methods - the methods to execute, possibly empty
    
    Throws:
    
    ErrorConditionException - the first thrown by any method
    
    See Also:
    
    beforeImpl(), afterImpl()
  - callMethodImpl
```
protected BaseDataType callMethodImpl(java.lang.reflect.Method method,
                                      CallParameter[] parameterList)
```
    Execute list of methods implementation, collect the result.
    
    Parameters:
    
    method - the method to execute
    
    parameterList - the method call arguments or null for no arguments
    
    Returns:
    
    the array of results of each method call, the null value is used for methods returning VOID or a legacy error occurred
    
    See Also:
    
    executeImpl()
  - callMethodImpl
```
protected BaseDataType callMethodImpl(java.lang.reflect.Method method,
                                      java.lang.Object o,
                                      CallParameter[] parameters)
                               throws ErrorConditionException,
                                      LegacyErrorException
```
    Execute a method.
    
    Parameters:
    
    method - the method to execute
    
    o - the object to use, can be null for "static" methods.
    
    parameters - method call parameters, null for no parameters
    
    Returns:
    
    the result of the call or null for methods returning VOID or if a legacy error was raised
    
    Throws:
    
    ErrorConditionException - by the executed legacy code
    
    LegacyErrorException - legacy errors are not caught by this method
  - getTestObject
```
protected java.lang.Object getTestObject()
```
    Get test object. The test object is either a legacy class instance if tests are implemented as legacy class methods or a persistent procedure instance it tests are implemented as internal procedures.
    The value should be null if the test method is a static legacy class method.
    
    Returns:
    
    the test object or null
  - checkInstance
```
protected final void checkInstance(handle h)
```
    Throw error if the procedure instance is not valid.
    
    Parameters:
    
    h - the instance handle

Class AbstractFWDTestDescriptor

Nested Class Summary

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

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

Field Summary

Fields inherited from class com.goldencode.p2j.testengine.NoopDescriptor

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.testengine.NoopDescriptor

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface com.goldencode.util.Printable

Field Detail

tags

Constructor Detail

AbstractFWDTestDescriptor

AbstractFWDTestDescriptor

Method Detail

getTags

after

afterImpl

before

beforeImpl

cleanUp

cleanUpImpl

execute

executeImpl

getTags

prepare

prepareImpl

readExternal

toString

writeExternal

callLFMethodsImpl

callMethodImpl

callMethodImpl

getTestObject

checkInstance