com.legstar.base.type.primitive

Class CobolPrimitiveType<T>

java.lang.Object

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

Type Parameters:

T - the underlying java type

All Implemented Interfaces:

CobolOptionalType, CobolType

Direct Known Subclasses:

CobolDecimalType, CobolDoubleType, CobolFloatType, CobolStringType

public abstract class CobolPrimitiveType<T>
extends Object
implements CobolType, CobolOptionalType

A primitive COBOL type.

Because primitive types tend to have lots of optional properties they are created using Builders.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	accept(CobolVisitor visitor) Propagate a visitor.
abstract FromHostPrimitiveResult<T>	fromHost(Class<T> javaClass, CobolContext cobolContext, byte[] hostData, int start) Convert mainframe data into a Java object.
FromHostPrimitiveResult<T>	fromHost(CobolContext cobolContext, byte[] hostData, int start) Convert mainframe data into a Java object.
abstract int	getBytesLen() Determine the length in bytes of the mainframe representation of this type.
String	getCobolName() Get the original COBOL name of this type.
String	getDependingOn() Name of the field that conditions the existence of this type.
Class<T>	getJavaClass()
long	getMaxBytesLen() Determine the maximum length in bytes of the mainframe representation of this type.
long	getMinBytesLen() Determine the minimum length in bytes of the mainframe representation of this type.
boolean	isCustomVariable()
boolean	isOdoObject()
abstract boolean	isValid(Class<T> javaClass, CobolContext cobolContext, byte[] hostData, int start) Check if a byte array contains valid mainframe data for this type characteristics.
boolean	isValid(CobolContext cobolContext, byte[] hostData, int start) Check if a byte array contains valid mainframe data for this type characteristics.

Methods inherited from class java.lang.Object

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

Constructor Detail

CobolPrimitiveType

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

Method Detail

isValid

public boolean isValid(CobolContext cobolContext,
                       byte[] hostData,
                       int start)

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

Parameters:

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

isValid

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

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

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

fromHost

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

Convert mainframe data into a Java object.

Parameters:

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 mainframe value as a java object

getMaxBytesLen

public long getMaxBytesLen()

Determine the maximum length in bytes of the mainframe representation of this type.

Specified by:

getMaxBytesLen in interface CobolType

Returns:

the maximum size in bytes needed to store this type

getMinBytesLen

public long getMinBytesLen()

Determine the minimum length in bytes of the mainframe representation of this type.

Specified by:

getMinBytesLen in interface CobolType

Returns:

the minimum size in bytes needed to store this type

getBytesLen

public abstract int getBytesLen()

Determine the length in bytes of the mainframe representation of this type.

Returns:

the size in bytes needed to store this type

fromHost

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

Convert mainframe data into a Java object.

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

accept

public void accept(CobolVisitor visitor)

Propagate a visitor.

Specified by:

accept in interface CobolType

Parameters:

visitor - the visitor

getJavaClass

public Class<T> getJavaClass()

getCobolName

public String getCobolName()

Description copied from interface: CobolType

Get the original COBOL name of this type.

Specified by:

getCobolName in interface CobolType

Returns:

the original COBOL name of this type.

isOdoObject

public boolean isOdoObject()

isCustomVariable

public boolean isCustomVariable()

getDependingOn

public String getDependingOn()

Description copied from interface: CobolOptionalType

Name of the field that conditions the existence of this type.

Specified by:

getDependingOn in interface CobolOptionalType

Returns:

name of the field that conditions the existence of this type