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

java.lang.Object
- com.goldencode.p2j.util.AbstractParameter
- - com.goldencode.p2j.util.AbstractExtentParameter<T>
  - - com.goldencode.p2j.util.OutputExtentParameter<T>

Direct Known Subclasses:

OutputExtentField
```
public abstract class OutputExtentParameter<T extends BaseDataType>
extends AbstractExtentParameter<T>
```
Special wrapper used for variables passed as output extent parameters to functions or procedures. On normal function and procedure exit, if the reference for an output or input-output extent parameter has changed, this will update the caller's variable reference too.

Nested Class Summary
- Nested classes/interfaces inherited from class com.goldencode.p2j.util.AbstractParameter
  AbstractParameter.Scope, AbstractParameter.WorkArea

Field Summary
- Fields inherited from class com.goldencode.p2j.util.AbstractExtentParameter
  argType, convCtor, paramType, retConvCtor
- Fields inherited from class com.goldencode.p2j.util.AbstractParameter
  context, LOG

Constructor Summary

Constructors
Constructor and Description
`OutputExtentParameter()` The constructor responsible for instance initialization by calling `AbstractExtentParameter(BaseDataType[])`.
`OutputExtentParameter(T[] variable)` This constructor allows to provide additional initialization logic of the variable reference in the extending classes.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T[]`	`initParameter()` Initializes the indeterminate extent parameter reference.
`T[]`	`initParameter(int extent)` Initializes the indeterminate or determinate extent parameter reference depending on the `extent` value.
`static character[]`	`toCharacter(longchar[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`static date[]`	`toDate(datetime[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`static date[]`	`toDate(datetimetz[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`static datetime[]`	`toDatetime(date[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`static datetime[]`	`toDatetime(datetimetz[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`static datetimetz[]`	`toDatetimeTz(date[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`static datetimetz[]`	`toDatetimeTz(datetime[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`static decimal[]`	`toDecimal(int64[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`static decimal[]`	`toDecimal(integer[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`static int64[]`	`toInt64(decimal[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`static int64[]`	`toInt64(integer[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`static integer[]`	`toInteger(decimal[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`static integer[]`	`toInteger(int64[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`static longchar[]`	`toLongchar(character[] input)` Copy the input array into an output array, using the output type constructor for each non-null element.
`protected boolean`	`validateAssignment(java.lang.String endingRoutine, boolean function)` Output parameter validation logic.

Methods inherited from class com.goldencode.p2j.util.AbstractExtentParameter
assign, getParameter, getVariable, getVariableRef, getVariableSafe, performAssignment, registerParameter, release, setParameter, setReturnConversion, setVariable

Methods inherited from class com.goldencode.p2j.util.AbstractParameter
canRelease, getCurrentScope, getLocalParam, getScopeable, isExtentParameter, isParameter, isTableField, postProcessOutput, replaceParameter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OutputExtentParameter
```
public OutputExtentParameter()
```
    The constructor responsible for instance initialization by calling AbstractExtentParameter(BaseDataType[]).
  - OutputExtentParameter
```
public OutputExtentParameter(T[] variable)
```
    This constructor allows to provide additional initialization logic of the variable reference in the extending classes. The initialization logic is encapsulated in AbstractExtentParameter(BaseDataType[]).
    
    Parameters:
    
    variable - A valid and initialized variable reference.
- Method Detail
  - toInteger
```
public static integer[] toInteger(int64[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - toInteger
```
public static integer[] toInteger(decimal[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - toDecimal
```
public static decimal[] toDecimal(integer[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - toDecimal
```
public static decimal[] toDecimal(int64[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - toInt64
```
public static int64[] toInt64(integer[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - toInt64
```
public static int64[] toInt64(decimal[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - toCharacter
```
public static character[] toCharacter(longchar[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - toLongchar
```
public static longchar[] toLongchar(character[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - toDate
```
public static date[] toDate(datetime[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - toDate
```
public static date[] toDate(datetimetz[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - toDatetime
```
public static datetime[] toDatetime(datetimetz[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - toDatetime
```
public static datetime[] toDatetime(date[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - toDatetimeTz
```
public static datetimetz[] toDatetimeTz(date[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - toDatetimeTz
```
public static datetimetz[] toDatetimeTz(datetime[] input)
```
    Copy the input array into an output array, using the output type constructor for each non-null element.
    
    Parameters:
    
    input - The input array.
    
    Returns:
    
    The copy of the input array, with the elements converted to the output data type.
  - initParameter
```
public T[] initParameter()
```
    Initializes the indeterminate extent parameter reference.
    
    Specified by:
    
    initParameter in class AbstractExtentParameter<T extends BaseDataType>
    
    Returns:
    
    The initialized indeterminate extent parameter reference.
  - initParameter
```
public T[] initParameter(int extent)
```
    Initializes the indeterminate or determinate extent parameter reference depending on the extent value. A zero value will initialize an indeterminate extent, a positive integer will initialize a determinate extent. The extent will be registered with ArrayAssigner accordingly.
    
    Specified by:
    
    initParameter in class AbstractExtentParameter<T extends BaseDataType>
    
    Parameters:
    
    extent - The parameter extent size.
    
    Returns:
    
    The initialized indeterminate extent parameter reference.
  - validateAssignment
```
protected boolean validateAssignment(java.lang.String endingRoutine,
                                     boolean function)
```
    Output parameter validation logic. The method checks for runtime compatibility of the extent variable reference and parameter reference and raises an error if validation fails.
    
    Overrides:
    
    validateAssignment in class AbstractExtentParameter<T extends BaseDataType>
    
    Parameters:
    
    endingRoutine - The legacy name of the routine that is ending when these back assignments are performed.
    
    function - true if the called routine is a function.
    
    Returns:
    
    true if parameter is valid or false if it failed validation

Class OutputExtentParameter<T extends BaseDataType>

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.util.AbstractParameter

Field Summary

Fields inherited from class com.goldencode.p2j.util.AbstractExtentParameter

Fields inherited from class com.goldencode.p2j.util.AbstractParameter

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.util.AbstractExtentParameter

Methods inherited from class com.goldencode.p2j.util.AbstractParameter

Methods inherited from class java.lang.Object

Constructor Detail

OutputExtentParameter

OutputExtentParameter

Method Detail

toInteger

toInteger

toDecimal

toDecimal

toInt64

toInt64

toCharacter

toLongchar

toDate

toDate

toDatetime

toDatetime

toDatetimeTz

toDatetimeTz

initParameter

initParameter

validateAssignment