com.legstar.base.type.primitive

Class CobolDecimalType<T extends Number>

java.lang.Object

com.legstar.base.type.primitive.CobolPrimitiveType<T>

com.legstar.base.type.primitive.CobolDecimalType<T>

All Implemented Interfaces:

CobolOptionalType, CobolType

Direct Known Subclasses:

CobolBinaryType, CobolPackedDecimalType, CobolZonedDecimalType

public abstract class CobolDecimalType<T extends Number>
extends CobolPrimitiveType<T>

A generic type for mainframe decimals.

This is a broad class that covers pretty much all COBOL numerics apart from Float/Double.

The parameterized type T determines which java Number type this COBOL decimal is converted to.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CobolDecimalType.Builder<T extends Number,B extends CobolDecimalType.Builder<T,B>>

Field Summary

Fields

Modifier and Type	Field and Description
protected static char	JAVA_DECIMAL_POINT

Constructor Summary

Constructors

Constructor and Description
CobolDecimalType(CobolDecimalType.Builder<T,?> builder)

Method Summary

Modifier and Type	Method and Description
FromHostPrimitiveResult<T>	fromHost(Class<T> javaClass, CobolContext cobolContext, byte[] hostData, int start) Convert mainframe data into a Java object.
protected abstract FromHostPrimitiveResult<T>	fromHostInternal(Class<T> javaClass, CobolContext cobolContext, byte[] hostData, int start) Convert mainframe data into a java Number.
char	getDigit(int index) Convert a nibble content to a java digit.
int	getFractionDigits()
T	getMaxInclusive()
T	getMinInclusive()
int	getTotalDigits()
boolean	isDigit(int nibble) Check if a nibble contains a valid digit.
boolean	isSigned()
boolean	isValid(Class<T> javaClass, CobolContext cobolContext, byte[] hostData, int start) Check if a byte array contains valid mainframe data for this type characteristics.
protected abstract boolean	isValidInternal(Class<T> javaClass, CobolContext cobolContext, byte[] hostData, int start) Check if a byte array contains a valid type with this instance characteristics.
void	setNibbles(int[] nibbles, byte hostByte) A nibble is a half byte.
static <D extends Number> D	valueOf(Class<D> clazz, ByteBuffer bb, int fractionDigits) Given a byte buffer containing the 2's complement representation of an unscaled numeric, convert that to the target java Number type.
static <D extends Number> D	valueOf(Class<D> clazz, String str) Given a string representation of a numeric value, convert that to the target java Number type.

Methods inherited from class com.legstar.base.type.primitive.CobolPrimitiveType

accept, fromHost, getBytesLen, getCobolName, getDependingOn, getJavaClass, getMaxBytesLen, getMinBytesLen, isCustomVariable, isOdoObject, isValid

Methods inherited from class java.lang.Object

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

Field Detail

JAVA_DECIMAL_POINT

protected static final char JAVA_DECIMAL_POINT

See Also:

Constant Field Values

Constructor Detail

CobolDecimalType

public CobolDecimalType(CobolDecimalType.Builder<T,?> builder)

Method Detail

isValid

public final boolean isValid(Class<T> javaClass,
                             CobolContext cobolContext,
                             byte[] hostData,
                             int start)

Check if a byte array contains valid mainframe data for this type characteristics.

Specified by:

isValid in class CobolPrimitiveType<T extends Number>

Parameters:

javaClass - target java type

cobolContext - host COBOL configuration parameters

hostData - the byte array containing mainframe data

start - the start position for the expected type in the byte array

Returns:

true if the byte array contains a valid type

isValidInternal

protected abstract boolean isValidInternal(Class<T> javaClass,
                                           CobolContext cobolContext,
                                           byte[] hostData,
                                           int start)

Check if a byte array contains a valid type with this instance characteristics.

Parameters:

javaClass - java Number class mapped to this COBOL decimal

cobolContext - host COBOL configuration parameters

hostData - the byte array containing mainframe data

start - the start position for the expected type in the byte array

Returns:

true if the byte array contains a valid type

fromHost

public FromHostPrimitiveResult<T> fromHost(Class<T> javaClass,
                                           CobolContext cobolContext,
                                           byte[] hostData,
                                           int start)

Convert mainframe data into a Java object.

Specified by:

fromHost in class CobolPrimitiveType<T extends Number>

Parameters:

javaClass - target java type

cobolContext - host COBOL configuration parameters

hostData - the byte array containing mainframe data

start - the start position for the expected type in the byte array

Returns:

the conversion results, including the mainframe value as a java object if conversion succeeded

fromHostInternal

protected abstract FromHostPrimitiveResult<T> fromHostInternal(Class<T> javaClass,
                                                               CobolContext cobolContext,
                                                               byte[] hostData,
                                                               int start)

Convert mainframe data into a java Number.

Parameters:

javaClass - java Number class mapped to this COBOL decimal

cobolContext - host COBOL configuration parameters

hostData - the byte array containing mainframe data

start - the start position for the expected type in the byte array

Returns:

the conversion results, including the mainframe value as a java object if conversion succeeded

setNibbles

public void setNibbles(int[] nibbles,
                       byte hostByte)

A nibble is a half byte.

Parameters:

nibbles - to be populated

hostByte - the incoming byte

getDigit

public char getDigit(int index)

Convert a nibble content to a java digit.

Parameters:

index - the nibble content is a value between 0 and 9 givig the index of the digit

Returns:

the java digit corresponding to the nibble value or null if the nibble is not a digit

isDigit

public boolean isDigit(int nibble)

Check if a nibble contains a valid digit.

Parameters:

nibble - the nibble to check

Returns:

true if this nibble is a valid digit

valueOf

public static <D extends Number> D valueOf(Class<D> clazz,
                                           String str)

Given a string representation of a numeric value, convert that to the target java Number type.

If the target is an integer type, we trim any fractional part.

Type Parameters:

D - a number type

Parameters:

clazz - the java Number type

str - the string representation of a numeric value

Returns:

the java Number obtained from the input string

Throws:

NumberFormatException - if umber cannot be derived from the input string

valueOf

public static <D extends Number> D valueOf(Class<D> clazz,
                                           ByteBuffer bb,
                                           int fractionDigits)

Given a byte buffer containing the 2's complement representation of an unscaled numeric, convert that to the target java Number type.

Note that there is an assumption that the byte buffer contains at least 8

Type Parameters:

D - a number type

Parameters:

clazz - the java Number type

bb - byte buffer containing the 2's complement representation of an unscaled numeric

fractionDigits - the number of fraction digits in the COBOL type

Returns:

java Number type corresponding to byte content

isSigned

public boolean isSigned()

getTotalDigits

public int getTotalDigits()

getFractionDigits

public int getFractionDigits()

getMinInclusive

public T getMinInclusive()

getMaxInclusive

public T getMaxInclusive()