com.goldencode.p2j.comauto

Class ComParameter

java.lang.Object

com.goldencode.p2j.comauto.ComParameter

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class ComParameter
extends java.lang.Object
implements java.io.Externalizable

Holds details for a COM parameter specified at a COM object method call.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComParameter.DataType The data type for an AS clause.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	byPointer Flag matching true if BY-POINTER option is used.
private boolean	byVariantPointer Flag matching true if BY-VARIANT-POINTER option is used.
private ComParameter.DataType	dataType Parameter's AS data-type option, or null if not used.
private boolean	extent Flag identifying if the value is an extent variable.
private java.lang.String	fwdDataType Used only by the native side, a string representation of this data type, in FWD terms.
private int	length In case of extent, the current var's length (can be zero for uninitialized dynamic extent).
private char	mode The parameter's mode, 'I', 'O' or 'U'.
private java.util.function.Consumer<BaseDataType[]>	refReplacement The reference replacement in case of output/input-output dynamic extent values.
private java.lang.Object	value The parameter's value.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ComParameter() Default c'tor.
private	ComParameter(char mode, java.lang.Object value, ComParameter.DataType dataType, boolean byPointer, boolean byVariantPointer, java.util.function.Consumer<BaseDataType[]> ref) Create a new instance with the specified details.
(package private)	ComParameter(ComParameter aparam) Create a copy of the specified parameter.

Method Summary

Modifier and Type	Method and Description
ComParameter.DataType	getDataType() Get the dataType state.
java.lang.String	getFwdDataType() Get the parameter's fwdDataType.
int	getLength() Get the parameter's length.
char	getMode() Get the parameter's mode.
java.util.function.Consumer<BaseDataType[]>	getRefReplacement() Get the reference replacement lambda expression.
java.lang.Object	getValue() Get the parameter's value.
static ComParameter	input() Create an INPUT parameter with an unknown value.
static ComParameter	input(java.lang.Object value) Create an INPUT parameter with the specified value.
static ComParameter	input(java.lang.Object value, boolean isPointer) Create an INPUT parameter with the specified details.
static ComParameter	input(java.lang.Object value, boolean isPointer, java.util.function.Consumer<BaseDataType[]> ref) Create an INPUT parameter with the specified details.
static ComParameter	input(java.lang.Object value, ComParameter.DataType dataType) Create an INPUT parameter with the specified details.
static ComParameter	input(java.lang.Object value, ComParameter.DataType dataType, boolean isPointer) Create an INPUT parameter with the specified details.
static ComParameter	input(java.lang.Object value, ComParameter.DataType dataType, boolean isPointer, java.util.function.Consumer<BaseDataType[]> ref) Create an INPUT parameter with the specified details.
static ComParameter	input(java.lang.Object value, ComParameter.DataType dataType, java.util.function.Consumer<BaseDataType[]> ref) Create an INPUT parameter with the specified details.
static ComParameter	input(java.lang.Object value, java.util.function.Consumer<BaseDataType[]> ref) Create an INPUT parameter with the specified value.
static ComParameter	inputOutput(java.lang.Object value) Create an INPUT-OUTPUT parameter with the specified value.
static ComParameter	inputOutput(java.lang.Object value, boolean isPointer) Create an INPUT-OUTPUT parameter with the specified details.
static ComParameter	inputOutput(java.lang.Object value, boolean isPointer, java.util.function.Consumer<BaseDataType[]> ref) Create an INPUT-OUTPUT parameter with the specified details.
static ComParameter	inputOutput(java.lang.Object value, ComParameter.DataType dataType) Create an INPUT-OUTPUT parameter with the specified details.
static ComParameter	inputOutput(java.lang.Object value, ComParameter.DataType dataType, boolean isPointer) Create an INPUT-OUTPUT parameter with the specified details.
static ComParameter	inputOutput(java.lang.Object value, ComParameter.DataType dataType, boolean isPointer, java.util.function.Consumer<BaseDataType[]> ref) Create an INPUT-OUTPUT parameter with the specified details.
static ComParameter	inputOutput(java.lang.Object value, ComParameter.DataType dataType, java.util.function.Consumer<BaseDataType[]> ref) Create an INPUT-OUTPUT parameter with the specified details.
static ComParameter	inputOutput(java.lang.Object value, java.util.function.Consumer<BaseDataType[]> ref) Create an INPUT-OUTPUT parameter with the specified value.
boolean	isByPointer() Check the byPointer flag.
boolean	isByVariantPointer() Check the byVariantPointer flag.
boolean	isExtent() Check if this parameter is an extent parameter.
boolean	isInputOutput() Check if this is an INPUT-OUTPUT parameter.
boolean	isOutput() Check if this is an OUTPUT parameter.
static ComParameter	output(java.lang.Object value) Create an OUTPUT parameter with the specified value.
static ComParameter	output(java.lang.Object value, boolean isPointer) Create an OUTPUT parameter with the specified details.
static ComParameter	output(java.lang.Object value, boolean isPointer, java.util.function.Consumer<BaseDataType[]> ref) Create an OUTPUT parameter with the specified details.
static ComParameter	output(java.lang.Object value, ComParameter.DataType dataType) Create an OUTPUT parameter with the specified details.
static ComParameter	output(java.lang.Object value, ComParameter.DataType dataType, boolean isPointer) Create an OUTPUT parameter with the specified details.
static ComParameter	output(java.lang.Object value, ComParameter.DataType dataType, boolean isPointer, java.util.function.Consumer<BaseDataType[]> ref) Create an OUTPUT parameter with the specified details.
static ComParameter	output(java.lang.Object value, ComParameter.DataType dataType, java.util.function.Consumer<BaseDataType[]> ref) Create an OUTPUT parameter with the specified details.
static ComParameter	output(java.lang.Object value, java.util.function.Consumer<BaseDataType[]> ref) Create an OUTPUT parameter with the specified value.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
void	setByPointer(boolean byPointer) Set the byPointer flag.
void	setByVariantPointer(boolean byVariantPointer) Set the byVariantPointer flag.
void	setDataType(ComParameter.DataType dataType) Set the parameter's dataType.
void	setExtent(boolean extent) Mark this parameter as an extent.
void	setFwdDataType(java.lang.String fwdDataType) Set the parameter's fwdDataType.
void	setLength(int length) Set the length of an extent parameter.
void	setMode(char mode) Set the parameter's mode.
void	setValue(java.lang.Object value) Set the parameter's value.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mode

private char mode

The parameter's mode, 'I', 'O' or 'U'.

value

private java.lang.Object value

The parameter's value.

byPointer

private boolean byPointer

Flag matching true if BY-POINTER option is used.

byVariantPointer

private boolean byVariantPointer

Flag matching true if BY-VARIANT-POINTER option is used.

dataType

private ComParameter.DataType dataType

Parameter's AS data-type option, or null if not used.

fwdDataType

private java.lang.String fwdDataType

Used only by the native side, a string representation of this data type, in FWD terms.

extent

private boolean extent

Flag identifying if the value is an extent variable.

length

private int length

In case of extent, the current var's length (can be zero for uninitialized dynamic extent).

refReplacement

private final java.util.function.Consumer<BaseDataType[]> refReplacement

The reference replacement in case of output/input-output dynamic extent values.

Constructor Detail

ComParameter

public ComParameter()

Default c'tor.

ComParameter

ComParameter(ComParameter aparam)

Create a copy of the specified parameter.

Parameters:

aparam - Parameter to copy.

ComParameter

private ComParameter(char mode,
                     java.lang.Object value,
                     ComParameter.DataType dataType,
                     boolean byPointer,
                     boolean byVariantPointer,
                     java.util.function.Consumer<BaseDataType[]> ref)

Create a new instance with the specified details.

Parameters:

mode - The parameter's mode, 'I', 'O' or 'U'.

value - The parameter's value.

dataType - Parameter's AS data-type option.

byPointer - Flag matching true if BY-POINTER option is used.

byVariantPointer - Flag matching true if BY-VARIANT-POINTER option is used.

ref - The reference replacement for dynamic extent variables.

Method Detail

input

public static ComParameter input()

Create an INPUT parameter with an unknown value.

Returns:

The created ComParameter instance.

input

public static ComParameter input(java.lang.Object value)

Create an INPUT parameter with the specified value.

Parameters:

value - The parameter's value.

Returns:

The created ComParameter instance.

output

public static ComParameter output(java.lang.Object value)

Create an OUTPUT parameter with the specified value.

Parameters:

value - The parameter's value.

Returns:

The created ComParameter instance.

inputOutput

public static ComParameter inputOutput(java.lang.Object value)

Create an INPUT-OUTPUT parameter with the specified value.

Parameters:

value - The parameter's value.

Returns:

The created ComParameter instance.

input

public static ComParameter input(java.lang.Object value,
                                 ComParameter.DataType dataType)

Create an INPUT parameter with the specified details.

Parameters:

value - The parameter's value.

dataType - Parameter's AS data-type option.

Returns:

The created ComParameter instance.

output

public static ComParameter output(java.lang.Object value,
                                  ComParameter.DataType dataType)

Create an OUTPUT parameter with the specified details.

Parameters:

value - The parameter's value.

dataType - Parameter's AS data-type option.

Returns:

The created ComParameter instance.

inputOutput

public static ComParameter inputOutput(java.lang.Object value,
                                       ComParameter.DataType dataType)

Create an INPUT-OUTPUT parameter with the specified details.

Parameters:

value - The parameter's value.

dataType - Parameter's AS data-type option.

Returns:

The created ComParameter instance.

input

public static ComParameter input(java.lang.Object value,
                                 ComParameter.DataType dataType,
                                 boolean isPointer)

Create an INPUT parameter with the specified details.

Parameters:

value - The parameter's value.

dataType - Parameter's AS data-type option.

isPointer - true represents BY-POINTER option, false represents BY-VARIANT-POINTER option.

Returns:

The created ComParameter instance.

output

public static ComParameter output(java.lang.Object value,
                                  ComParameter.DataType dataType,
                                  boolean isPointer)

Create an OUTPUT parameter with the specified details.

Parameters:

value - The parameter's value.

dataType - Parameter's AS data-type option.

isPointer - true represents BY-POINTER option, false represents BY-VARIANT-POINTER option.

Returns:

The created ComParameter instance.

inputOutput

public static ComParameter inputOutput(java.lang.Object value,
                                       ComParameter.DataType dataType,
                                       boolean isPointer)

Create an INPUT-OUTPUT parameter with the specified details.

Parameters:

value - The parameter's value.

dataType - Parameter's AS data-type option.

isPointer - true represents BY-POINTER option, false represents BY-VARIANT-POINTER option.

Returns:

The created ComParameter instance.

input

public static ComParameter input(java.lang.Object value,
                                 boolean isPointer)

Create an INPUT parameter with the specified details.

Parameters:

value - The parameter's value.

isPointer - true represents BY-POINTER option, false represents BY-VARIANT-POINTER option.

Returns:

The created ComParameter instance.

output

public static ComParameter output(java.lang.Object value,
                                  boolean isPointer)

Create an OUTPUT parameter with the specified details.

Parameters:

value - The parameter's value.

isPointer - true represents BY-POINTER option, false represents BY-VARIANT-POINTER option.

Returns:

The created ComParameter instance.

inputOutput

public static ComParameter inputOutput(java.lang.Object value,
                                       boolean isPointer)

Create an INPUT-OUTPUT parameter with the specified details.

Parameters:

value - The parameter's value.

isPointer - true represents BY-POINTER option, false represents BY-VARIANT-POINTER option.

Returns:

The created ComParameter instance.

input

public static ComParameter input(java.lang.Object value,
                                 java.util.function.Consumer<BaseDataType[]> ref)

Create an INPUT parameter with the specified value.

Parameters:

value - The parameter's value.

ref - The reference replacement for dynamic extent variables.

Returns:

The created ComParameter instance.

output

public static ComParameter output(java.lang.Object value,
                                  java.util.function.Consumer<BaseDataType[]> ref)

Create an OUTPUT parameter with the specified value.

Parameters:

value - The parameter's value.

ref - The reference replacement for dynamic extent variables.

Returns:

The created ComParameter instance.

inputOutput

public static ComParameter inputOutput(java.lang.Object value,
                                       java.util.function.Consumer<BaseDataType[]> ref)

Create an INPUT-OUTPUT parameter with the specified value.

Parameters:

value - The parameter's value.

ref - The reference replacement for dynamic extent variables.

Returns:

The created ComParameter instance.

input

public static ComParameter input(java.lang.Object value,
                                 ComParameter.DataType dataType,
                                 java.util.function.Consumer<BaseDataType[]> ref)

Create an INPUT parameter with the specified details.

Parameters:

value - The parameter's value.

dataType - Parameter's AS data-type option.

ref - The reference replacement for dynamic extent variables.

Returns:

The created ComParameter instance.

output

public static ComParameter output(java.lang.Object value,
                                  ComParameter.DataType dataType,
                                  java.util.function.Consumer<BaseDataType[]> ref)

Create an OUTPUT parameter with the specified details.

Parameters:

value - The parameter's value.

dataType - Parameter's AS data-type option.

ref - The reference replacement for dynamic extent variables.

Returns:

The created ComParameter instance.

inputOutput

public static ComParameter inputOutput(java.lang.Object value,
                                       ComParameter.DataType dataType,
                                       java.util.function.Consumer<BaseDataType[]> ref)

Create an INPUT-OUTPUT parameter with the specified details.

Parameters:

value - The parameter's value.

dataType - Parameter's AS data-type option.

ref - The reference replacement for dynamic extent variables.

Returns:

The created ComParameter instance.

input

public static ComParameter input(java.lang.Object value,
                                 ComParameter.DataType dataType,
                                 boolean isPointer,
                                 java.util.function.Consumer<BaseDataType[]> ref)

Create an INPUT parameter with the specified details.

Parameters:

value - The parameter's value.

dataType - Parameter's AS data-type option.

isPointer - true represents BY-POINTER option, false represents BY-VARIANT-POINTER option.

ref - The reference replacement for dynamic extent variables.

Returns:

The created ComParameter instance.

output

public static ComParameter output(java.lang.Object value,
                                  ComParameter.DataType dataType,
                                  boolean isPointer,
                                  java.util.function.Consumer<BaseDataType[]> ref)

Create an OUTPUT parameter with the specified details.

Parameters:

value - The parameter's value.

dataType - Parameter's AS data-type option.

isPointer - true represents BY-POINTER option, false represents BY-VARIANT-POINTER option.

ref - The reference replacement for dynamic extent variables.

Returns:

The created ComParameter instance.

inputOutput

public static ComParameter inputOutput(java.lang.Object value,
                                       ComParameter.DataType dataType,
                                       boolean isPointer,
                                       java.util.function.Consumer<BaseDataType[]> ref)

Create an INPUT-OUTPUT parameter with the specified details.

Parameters:

value - The parameter's value.

dataType - Parameter's AS data-type option.

isPointer - true represents BY-POINTER option, false represents BY-VARIANT-POINTER option.

ref - The reference replacement for dynamic extent variables.

Returns:

The created ComParameter instance.

input

public static ComParameter input(java.lang.Object value,
                                 boolean isPointer,
                                 java.util.function.Consumer<BaseDataType[]> ref)

Create an INPUT parameter with the specified details.

Parameters:

value - The parameter's value.

isPointer - true represents BY-POINTER option, false represents BY-VARIANT-POINTER option.

ref - The reference replacement for dynamic extent variables.

Returns:

The created ComParameter instance.

output

public static ComParameter output(java.lang.Object value,
                                  boolean isPointer,
                                  java.util.function.Consumer<BaseDataType[]> ref)

Create an OUTPUT parameter with the specified details.

Parameters:

value - The parameter's value.

isPointer - true represents BY-POINTER option, false represents BY-VARIANT-POINTER option.

ref - The reference replacement for dynamic extent variables.

Returns:

The created ComParameter instance.

inputOutput

public static ComParameter inputOutput(java.lang.Object value,
                                       boolean isPointer,
                                       java.util.function.Consumer<BaseDataType[]> ref)

Create an INPUT-OUTPUT parameter with the specified details.

Parameters:

value - The parameter's value.

isPointer - true represents BY-POINTER option, false represents BY-VARIANT-POINTER option.

ref - The reference replacement for dynamic extent variables.

Returns:

The created ComParameter instance.

isOutput

public boolean isOutput()

Check if this is an OUTPUT parameter.

Returns:

See above.

isInputOutput

public boolean isInputOutput()

Check if this is an INPUT-OUTPUT parameter.

Returns:

See above.

isByPointer

public boolean isByPointer()

Check the byPointer flag.

Returns:

true if the BY-POINTER option is used.

setByPointer

public void setByPointer(boolean byPointer)

Set the byPointer flag.

Parameters:

byPointer - true if the BY-POINTER option is used.

isByVariantPointer

public boolean isByVariantPointer()

Check the byVariantPointer flag.

Returns:

true if the BY-VARIANT-POINTER option is used.

setByVariantPointer

public void setByVariantPointer(boolean byVariantPointer)

Set the byVariantPointer flag.

Parameters:

byVariantPointer - true if the BY-VARIANT-POINTER option is used.

getDataType

public ComParameter.DataType getDataType()

Get the dataType state.

Returns:

null if no AS data-type option

setDataType

public void setDataType(ComParameter.DataType dataType)

Set the parameter's dataType.

Parameters:

dataType - The parameter's AS data-type option or null if not in use.

getValue

public java.lang.Object getValue()

Get the parameter's value.

Returns:

See above.

setValue

public void setValue(java.lang.Object value)

Set the parameter's value.

Parameters:

value - The parameter's value.

getMode

public char getMode()

Get the parameter's mode.

Returns:

See above.

setMode

public void setMode(char mode)

Set the parameter's mode. Only 'I', 'U' or 'O' characters are accepted.

Parameters:

mode - The parameter's mode.

Throws:

java.lang.IllegalArgumentException - If mode is not one of 'I', 'U' or 'O' characters.

getFwdDataType

public java.lang.String getFwdDataType()

Get the parameter's fwdDataType.

Returns:

See above.

setFwdDataType

public void setFwdDataType(java.lang.String fwdDataType)

Set the parameter's fwdDataType.

Parameters:

fwdDataType - The FWD data-type name.

See Also:

for possible types.

isExtent

public boolean isExtent()

Check if this parameter is an extent parameter.

Returns:

See above.

setExtent

public void setExtent(boolean extent)

Mark this parameter as an extent.

Parameters:

extent - true if this is an extent variable.

getLength

public int getLength()

Get the parameter's length. Used only if extent is true.

Returns:

See above.

getRefReplacement

public java.util.function.Consumer<BaseDataType[]> getRefReplacement()

Get the reference replacement lambda expression.

Returns:

See above.

setLength

public void setLength(int length)

Set the length of an extent parameter.

Parameters:

length - The array length.

writeExternal

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

Replacement for the default object writing method. The latest state is written to the output destination.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.

readExternal

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

Replacement for the default object reading method. The latest state is read from the input source.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - The input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.