com.legstar.coxb
Annotation Type CobolElement

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface CobolElement

Cobol annotations persist at execution time.

Required Element Summary

String

cobolName Cobol element name.

Optional Element Summary

int	byteLength Deprecated. Cobol element length in bytes.
String	dependingOn Cobol element giving array actual size.
int	fractionDigits Numerics fractional number of digits.
boolean	isCustomVariable True if this element is used in custom code.
boolean	isJustifiedRight String justification.
boolean	isODOObject Determines the size of a variable size array.
boolean	isRedefined Element is redefined by at least one other element.
boolean	isSigned Numerics signed or unsigned.
boolean	isSignLeading Numerics sign in leading byte or trailing byte.
boolean	isSignSeparate Numerics sign occupies a separate byte.
int	levelNumber Level in the hierarchy this element was parsed from.
String	marshalChoiceStrategyClassName Name of class providing logic to help with alternative selection.
int	maxOccurs Arrays maximum number of occurences.
int	minOccurs Arrays minimum number of occurences.
String	picture Cobol picture clause.
String	redefines Cobol element sharing same memory location.
int	srceLine Line number in the original source file this element was parsed from.
int	totalDigits Numerics total number of digits (including fractional).
CobolType	type Cobol element type.
String	unmarshalChoiceStrategyClassName Name of class providing logic to help with alternative selection.
String	usage Cobol usage.
String	value Cobol default value.

Element Detail

cobolName

public abstract String cobolName

Cobol element name.

type

public abstract CobolType type

Cobol element type.

Default:

com.legstar.coxb.CobolType.ALPHANUMERIC_ITEM

isJustifiedRight

public abstract boolean isJustifiedRight

String justification.

Default:

false

byteLength

public abstract int byteLength

Deprecated. Cobol element length in bytes.

Default:

0

totalDigits

public abstract int totalDigits

Numerics total number of digits (including fractional).

Default:

0

fractionDigits

public abstract int fractionDigits

Numerics fractional number of digits.

Default:

0

isSigned

public abstract boolean isSigned

Numerics signed or unsigned.

Default:

false

isSignLeading

public abstract boolean isSignLeading

Numerics sign in leading byte or trailing byte.

Default:

false

isSignSeparate

public abstract boolean isSignSeparate

Numerics sign occupies a separate byte.

Default:

false

minOccurs

public abstract int minOccurs

Arrays minimum number of occurences.

Default:

0

maxOccurs

public abstract int maxOccurs

Arrays maximum number of occurences.

Default:

0

dependingOn

public abstract String dependingOn

Cobol element giving array actual size.

Default:

""

isODOObject

public abstract boolean isODOObject

Determines the size of a variable size array.

Default:

false

redefines

public abstract String redefines

Cobol element sharing same memory location.

Default:

""

isRedefined

public abstract boolean isRedefined

Element is redefined by at least one other element.

Default:

false

isCustomVariable

public abstract boolean isCustomVariable

True if this element is used in custom code.

Default:

false

unmarshalChoiceStrategyClassName

public abstract String unmarshalChoiceStrategyClassName

Name of class providing logic to help with alternative selection. Host to Java.

Default:

""

marshalChoiceStrategyClassName

public abstract String marshalChoiceStrategyClassName

Name of class providing logic to help with alternative selection. Java to Host.

Default:

""

levelNumber

public abstract int levelNumber

Level in the hierarchy this element was parsed from.

Default:

1

picture

public abstract String picture

Cobol picture clause.

Default:

""

usage

public abstract String usage

Cobol usage.

Default:

""

value

public abstract String value

Cobol default value.

Default:

""

srceLine

public abstract int srceLine

Line number in the original source file this element was parsed from.

Default:

1