com.goldencode.p2j.uast

Class ParameterKey

java.lang.Object

com.goldencode.p2j.uast.ParameterKey

public class ParameterKey
extends java.lang.Object

Container for a parameter's key, including its data type and mode. Used both at caller and at the OO method definition.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	dynamicPoly Flag indicating if the caller's argument is from a direct method call with poly arguments.
(package private) boolean	fromExpression Flag indicating if the caller's argument is an expression.
(package private) java.lang.Integer	mode The parameter mode.
(package private) java.lang.String	type The parameter's data type.

Constructor Summary

Constructors

Constructor and Description
ParameterKey(java.lang.Integer mode, java.lang.String type) Create a new parameter key.
ParameterKey(java.lang.Integer mode, java.lang.String type, boolean fromExpression, boolean dynamicPoly) Create a new parameter key.
ParameterKey(LegacyParameter lparam) Create a new parameter key.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other) Test other object for equality.
int	hashCode() Computes the hash code for this object.
boolean	isExtent() Check if this parameter is extent.
boolean	isFromExpression() Check if the argument is from an expression.
java.lang.String	render() Describe the instance as a 4GL parameter.
private java.lang.String	renderMode() Get a string representation of the mode.
private java.lang.String	renderType() Get a string representation of the mode.
java.lang.String	scalarType() Report the type without any encoded extent.
java.lang.String	toJava() Convert this parameter key to its converted Java equivalent.
java.lang.String	toString() Get a string representation of this parameter key.
boolean	typeEquivalent(ParameterKey other) Report if the type of the two parameters is the same.

Methods inherited from class java.lang.Object

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

Field Detail

mode

final java.lang.Integer mode

The parameter mode. May be null in case of BUFFER.

type

final java.lang.String type

The parameter's data type.

fromExpression

final boolean fromExpression

Flag indicating if the caller's argument is an expression.

dynamicPoly

final boolean dynamicPoly

Flag indicating if the caller's argument is from a direct method call with poly arguments.

Constructor Detail

ParameterKey

public ParameterKey(java.lang.Integer mode,
                    java.lang.String type)

Create a new parameter key.

Parameters:

mode - The parameter mode.

type - The parameter type.

ParameterKey

public ParameterKey(java.lang.Integer mode,
                    java.lang.String type,
                    boolean fromExpression,
                    boolean dynamicPoly)

Create a new parameter key.

Parameters:

mode - The parameter mode.

type - The parameter type.

fromExpression - Flag indicating if the caller's argument is an expression.

dynamicPoly - Flag indicating if the caller's argument is from a direct method call with poly arguments.

ParameterKey

public ParameterKey(LegacyParameter lparam)

Create a new parameter key.

Parameters:

lparam - The legacy parameter annotation.

Method Detail

typeEquivalent

public boolean typeEquivalent(ParameterKey other)

Report if the type of the two parameters is the same. The mode is not considered.

Parameters:

other - The instance to compare against.

Returns:

true if the types are the same or are both null. If they are different (including if only one is null) then false will be returned.

scalarType

public java.lang.String scalarType()

Report the type without any encoded extent.

Returns:

The type with any extent portion removed.

isFromExpression

public boolean isFromExpression()

Check if the argument is from an expression.

Returns:

See above.

equals

public boolean equals(java.lang.Object other)

Test other object for equality.

Overrides:

equals in class java.lang.Object

Parameters:

other - The object to compare to.

Returns:

true only if the other object is equal to this one.

hashCode

public int hashCode()

Computes the hash code for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

The computed hash-code.

toString

public java.lang.String toString()

Get a string representation of this parameter key.

Overrides:

toString in class java.lang.Object

Returns:

See above.

render

public java.lang.String render()

Describe the instance as a 4GL parameter.

Returns:

See above.

isExtent

public boolean isExtent()

Check if this parameter is extent.

Returns:

See above.

toJava

public java.lang.String toJava()

Convert this parameter key to its converted Java equivalent.

Returns:

See above.

renderType

private java.lang.String renderType()

Get a string representation of the mode.

Returns:

The mode.

renderMode

private java.lang.String renderMode()

Get a string representation of the mode.

Returns:

The mode.