ICobolVar (Veryant isCOBOL Java Documentation)

All Superinterfaces:

CobValue

All Known Subinterfaces:

INumericVar, IObjectVar, IPicAlphaEdit, IPicAnyLength, IPicG, IPicN, IPicNumEdit
```
public interface ICobolVar
extends CobValue
```
Base Interface for all the isCOBOL variables and literals.

Field Summary

Fields
Modifier and Type Field and Description

static int LIKE_L_TRIM

static int LIKE_NOT_CS

static int LIKE_R_TRIM

static int LIKE_TRIM

Fields
Modifier and Type	Field and Description
`static int`	`LIKE_L_TRIM`
`static int`	`LIKE_NOT_CS`
`static int`	`LIKE_R_TRIM`
`static int`	`LIKE_TRIM`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`basicToString()` for internal use only
`int`	`compare(ICobolVar other)` compares this variable with the one specified by `other`
`int`	`compareTo(CobolNum val)` for internal use only
`void`	`dynSet(ICobolVar src)` for internal use only
`boolean`	`existsDynamicElement(int[] idxs)` for internal use only
`byte[]`	`getBytes()` returns the bytes contained in the memory buffer
`void`	`getBytes(byte[] dest, int len)` writes the bytes contained in the memory buffer in the array specified by `dest`
`Enumeration`	`getChildren()` if the variable is a group-item, returns an Enumeration of the child variables or an empty Enumeration otherwise
`int`	`getDependingDelta()` for internal use only
`ICobolVar`	`getDependingOn()` for internal use only
`int[]`	`getDimensions()` if the variable is a table, it returns an int array with its dimensions, or null otherwise
`int`	`getDynamicCapacity(int[] idxs)` for internal use only
`int`	`getDynamicCapacity(int[] idxs, boolean recur)` for internal use only
`ICobolVar`	`getIParent()` if the variable is a sub-item, it returns its parent, or null otherwise
`IXMLAttributes`	`getIXMLAttributes()` returns the XML attributes associated to this variable
`int`	`getLastDimension()` for internal use only
`int`	`getLength()` returns the variable length if the variable contains an OCCURS DEPENDING, it returns the length considering the current value of the DEPENDING ON variable if the variable is in the LINKAGE SECTION and it is not linked, it returns 0
`int`	`getMaxDimension()` for internal use only
`int`	`getMaxLength()` returns the variable length if the variable contains an OCCURS DEPENDING, it returns the maximum possible length
`int`	`getMemoryLength()` returns the length of the memory buffer currently associated to the variable if the variable is a sub-item, it returns the length of the memory of the 01 level if the variable is in the LINKAGE SECTION, it returns the length of the memory of the linked variable, or 0 if it is not linked
`String`	`getName()` returns the cobol name of the variable
`int`	`getOffset()` if the variable is a sub-item, it returns its offset in the group-item, or 0 otherwise
`Object`	`getOId()` for internal use only
`Enumeration`	`getRedefines()` if the variable is a group-item, returns an Enumeration of the REDEFINES variables contained in this group-item or an empty Enumeration otherwise
`int`	`getType()` for internal use only
`boolean`	`hasDynamicData()` returns true if `isDynamicLength()` returns true and at least one dynamic variable has a length greater than 0.
`void`	`initialize(int[] categories, ICobolVar[] src, boolean withFiller)` for internal use only
`ICobolVar`	`intIAt(int i)` for internal use only
`ICobolVar`	`intIAt(int[] i)` for internal use only
`ICobolVar`	`intIAtNoClone(int[] i)` for internal use only
`ICobolVar`	`intICopy()` for internal use only
`ICobolVar`	`intIOffs(int newOffset)` for internal use only
`ICobolVar`	`intISub(int start)` for internal use only
`ICobolVar`	`intISub(int start, int subLen)` for internal use only
`boolean`	`isDecimalPointComma()` returns true if the decimal point is ','
`boolean`	`isDynamicLength()` returns true if the variable is a group-item and it contains OCCURS DYNAMIC or ANY LENGTH variables
`boolean`	`isFinal()` returns true if the variable represents a constant, false otherwise
`boolean`	`isInDynamicTable()` for internal use only
`int`	`length()` returns the variable length if the variable contains an OCCURS DEPENDING, it returns the length considering the current value of the DEPENDING ON variable
`ICobolVar`	`link(ICobolVar v)` for internal use only
`ICobolVar`	`moveTo(ICobolVar dst)` writes the value of this variable into the variable specified by `dst`
`ICobolVar`	`moveTo(INumericVar dst)` writes the value of this variable into the variable specified by `dst`
`ICobolVar`	`moveTo(IPicNumEdit dst)` writes the value of this variable into the variable specified by `dst`
`boolean`	`set(boolean value)` sets the value of the variable with the specified boolean, the boolean will be converted in bytes before writing it in the memory buffer
`boolean`	`set(byte value)` sets the value of the variable with the specified byte
`boolean`	`set(byte[] src)` writes the bytes specified by `src` in the memory buffer
`boolean`	`set(byte[] src, int srcStart, int srcLen, boolean filling)` writes the bytes specified by `src` in the memory buffer
`boolean`	`set(char value)` sets the value of the variable with the specified char, the char will be converted in bytes before writing it in the memory buffer
`boolean`	`set(CobolNum value)` sets the value of the variable with the specified CobolNum, the CobolNum will be converted in bytes before writing it in the memory buffer
`boolean`	`set(double value)` sets the value of the variable with the specified double, the double will be converted in bytes before writing it in the memory buffer
`boolean`	`set(float value)` sets the value of the variable with the specified float, the float will be converted in bytes before writing it in the memory buffer
`boolean`	`set(int value)` sets the value of the variable with the specified int, the int will be converted in bytes before writing it in the memory buffer
`boolean`	`set(long value)` sets the value of the variable with the specified long, the long will be converted in bytes before writing it in the memory buffer
`boolean`	`set(short value)` sets the value of the variable with the specified short, the short will be converted in bytes before writing it in the memory buffer
`boolean`	`set(String value)` sets the value of the variable with the specified string, the string will be converted in bytes before writing it in the memory buffer
`boolean`	`set(String value, boolean filling)` sets the value of the variable with the specified string, the string will be converted in bytes before writing it in the memory buffer
`ICobolVar`	`setByVal(boolean bv)` for internal use only
`void`	`setOId(Object oid)` for internal use only
`void`	`setSpace()` fills the memory buffer with spaces
`boolean`	`setUsingMaxLen(byte[] src)` for internal use only
`void`	`setValue(ICobolVar value)` for internal use only
`boolean`	`toboolean()` returns a boolean representation of this variable
`byte`	`tobyte()` returns a byte representation of this variable
`char`	`tochar()` returns a char representation of this variable
`double`	`todouble()` returns a double representation of this variable
`float`	`tofloat()` returns a float representation of this variable
`int`	`toint()` returns a int representation of this variable
`long`	`tolong()` returns a long representation of this variable
`short`	`toshort()` returns a short representation of this variable
`String`	`toStringNoGui()` for internal use only
`ICobolVar`	`xmlClone()` for internal use only

Methods inherited from interface com.iscobol.rts.CobValue
eval, ieval, isJustified, moveToTable, toString

- Field Detail
  - LIKE_NOT_CS
```
static final int LIKE_NOT_CS
```
    See Also:
    
    Constant Field Values
  - LIKE_L_TRIM
```
static final int LIKE_L_TRIM
```
    See Also:
    
    Constant Field Values
  - LIKE_R_TRIM
```
static final int LIKE_R_TRIM
```
    See Also:
    
    Constant Field Values
  - LIKE_TRIM
```
static final int LIKE_TRIM
```
    See Also:
    
    Constant Field Values
- Method Detail
  - set
```
boolean set(byte[] src,
            int srcStart,
            int srcLen,
            boolean filling)
```
    writes the bytes specified by src in the memory buffer
    
    Parameters:
    
    src - the bytes to be written
    
    srcStart - the start offset
    
    srcLen - the number of bytes to be written
    
    filling - specifies if the buffer must be filled with spaces
    
    Returns:
    
    true if the variable is numeric and the set causes an overflow, false otherwise
  - set
```
boolean set(String value)
```
    sets the value of the variable with the specified string, the string will be converted in bytes before writing it in the memory buffer
    
    Parameters:
    
    value - the string value to be written
    
    Returns:
    
    true if the variable is numeric and the set causes an overflow, false otherwise
  - set
```
boolean set(String value,
            boolean filling)
```
    sets the value of the variable with the specified string, the string will be converted in bytes before writing it in the memory buffer
    
    Parameters:
    
    value - the string value to be written
    
    filling - specifies if the buffer must be filled with spaces
    
    Returns:
    
    true if the variable is numeric and the set causes an overflow, false otherwise
  - set
```
boolean set(byte[] src)
```
    writes the bytes specified by src in the memory buffer
    
    Parameters:
    
    src - the bytes to be written
    
    Returns:
    
    true if the variable is numeric and the set causes an overflow, false otherwise
  - set
```
boolean set(boolean value)
```
    sets the value of the variable with the specified boolean, the boolean will be converted in bytes before writing it in the memory buffer
    
    Parameters:
    
    value - the boolean value to be written
    
    Returns:
    
    true if the variable is numeric and the set causes an overflow, false otherwise
  - set
```
boolean set(byte value)
```
    sets the value of the variable with the specified byte
    
    Parameters:
    
    value - the byte value to be written
    
    Returns:
    
    true if the variable is numeric and the set causes an overflow, false otherwise
  - set
```
boolean set(char value)
```
    sets the value of the variable with the specified char, the char will be converted in bytes before writing it in the memory buffer
    
    Parameters:
    
    value - the char value to be written
    
    Returns:
    
    true if the variable is numeric and the set causes an overflow, false otherwise
  - set
```
boolean set(short value)
```
    sets the value of the variable with the specified short, the short will be converted in bytes before writing it in the memory buffer
    
    Parameters:
    
    value - the short value to be written
    
    Returns:
    
    true if the variable is numeric and the set causes an overflow, false otherwise
  - set
```
boolean set(int value)
```
    sets the value of the variable with the specified int, the int will be converted in bytes before writing it in the memory buffer
    
    Parameters:
    
    value - the int value to be written
    
    Returns:
    
    true if the variable is numeric and the set causes an overflow, false otherwise
  - set
```
boolean set(long value)
```
    sets the value of the variable with the specified long, the long will be converted in bytes before writing it in the memory buffer
    
    Parameters:
    
    value - the long value to be written
    
    Returns:
    
    true if the variable is numeric and the set causes an overflow, false otherwise
  - set
```
boolean set(float value)
```
    sets the value of the variable with the specified float, the float will be converted in bytes before writing it in the memory buffer
    
    Parameters:
    
    value - the float value to be written
    
    Returns:
    
    true if the variable is numeric and the set causes an overflow, false otherwise
  - set
```
boolean set(double value)
```
    sets the value of the variable with the specified double, the double will be converted in bytes before writing it in the memory buffer
    
    Parameters:
    
    value - the double value to be written
    
    Returns:
    
    true if the variable is numeric and the set causes an overflow, false otherwise
  - set
```
boolean set(CobolNum value)
```
    sets the value of the variable with the specified CobolNum, the CobolNum will be converted in bytes before writing it in the memory buffer
    
    Parameters:
    
    value - the CobolNum value to be written
    
    Returns:
    
    true if the variable is numeric and the set causes an overflow, false otherwise
  - setUsingMaxLen
```
boolean setUsingMaxLen(byte[] src)
```
    for internal use only
  - setValue
```
void setValue(ICobolVar value)
```
    for internal use only
  - setSpace
```
void setSpace()
```
    fills the memory buffer with spaces
  - compare
```
int compare(ICobolVar other)
```
    compares this variable with the one specified by other
    
    Parameters:
    
    other - the variable to be compared
    
    Returns:
    
    a negative integer, zero, or a positive integer as this variable is less than, equal to, or greater than the one specified by other.
  - getRedefines
```
Enumeration getRedefines()
```
    if the variable is a group-item, returns an Enumeration of the REDEFINES variables contained in this group-item or an empty Enumeration otherwise
  - getChildren
```
Enumeration getChildren()
```
    if the variable is a group-item, returns an Enumeration of the child variables or an empty Enumeration otherwise
  - toboolean
```
boolean toboolean()
```
    returns a boolean representation of this variable
    
    Specified by:
    
    toboolean in interface CobValue
  - tobyte
```
byte tobyte()
```
    returns a byte representation of this variable
    
    Specified by:
    
    tobyte in interface CobValue
  - tochar
```
char tochar()
```
    returns a char representation of this variable
    
    Specified by:
    
    tochar in interface CobValue
  - toshort
```
short toshort()
```
    returns a short representation of this variable
    
    Specified by:
    
    toshort in interface CobValue
  - toint
```
int toint()
```
    returns a int representation of this variable
    
    Specified by:
    
    toint in interface CobValue
  - tolong
```
long tolong()
```
    returns a long representation of this variable
    
    Specified by:
    
    tolong in interface CobValue
  - tofloat
```
float tofloat()
```
    returns a float representation of this variable
    
    Specified by:
    
    tofloat in interface CobValue
  - todouble
```
double todouble()
```
    returns a double representation of this variable
    
    Specified by:
    
    todouble in interface CobValue
  - getLength
```
int getLength()
```
    returns the variable length
    if the variable contains an OCCURS DEPENDING, it returns the length considering the current value of the DEPENDING ON variable
    if the variable is in the LINKAGE SECTION and it is not linked, it returns 0
  - length
```
int length()
```
    returns the variable length
    if the variable contains an OCCURS DEPENDING, it returns the length considering the current value of the DEPENDING ON variable
  - getMemoryLength
```
int getMemoryLength()
```
    returns the length of the memory buffer currently associated to the variable
    if the variable is a sub-item, it returns the length of the memory of the 01 level
    if the variable is in the LINKAGE SECTION, it returns the length of the memory of the linked variable, or 0 if it is not linked
  - getMaxLength
```
int getMaxLength()
```
    returns the variable length
    if the variable contains an OCCURS DEPENDING, it returns the maximum possible length
  - isFinal
```
boolean isFinal()
```
    returns true if the variable represents a constant, false otherwise
    
    Specified by:
    
    isFinal in interface CobValue
  - basicToString
```
String basicToString()
```
    for internal use only
  - getDimensions
```
int[] getDimensions()
```
    if the variable is a table, it returns an int array with its dimensions, or null otherwise
  - getLastDimension
```
int getLastDimension()
```
    for internal use only
  - getType
```
int getType()
```
    for internal use only
  - getOffset
```
int getOffset()
```
    if the variable is a sub-item, it returns its offset in the group-item, or 0 otherwise
  - intIAt
```
ICobolVar intIAt(int i)
```
    for internal use only
  - intIAt
```
ICobolVar intIAt(int[] i)
```
    for internal use only
  - intIAtNoClone
```
ICobolVar intIAtNoClone(int[] i)
```
    for internal use only
  - intICopy
```
ICobolVar intICopy()
```
    for internal use only
  - intISub
```
ICobolVar intISub(int start)
```
    for internal use only
  - intISub
```
ICobolVar intISub(int start,
                  int subLen)
```
    for internal use only
  - intIOffs
```
ICobolVar intIOffs(int newOffset)
```
    for internal use only
  - getMaxDimension
```
int getMaxDimension()
```
    for internal use only
  - getDependingOn
```
ICobolVar getDependingOn()
```
    for internal use only
  - getDependingDelta
```
int getDependingDelta()
```
    for internal use only
  - getBytes
```
void getBytes(byte[] dest,
              int len)
```
    writes the bytes contained in the memory buffer in the array specified by dest
    
    Parameters:
    
    dest - the destination byte array
    
    len - the maximum number of bytes to be written
  - getBytes
```
byte[] getBytes()
```
    returns the bytes contained in the memory buffer
  - getIParent
```
ICobolVar getIParent()
```
    if the variable is a sub-item, it returns its parent, or null otherwise
  - moveTo
```
ICobolVar moveTo(ICobolVar dst)
```
    writes the value of this variable into the variable specified by dst
    
    Parameters:
    
    dst - the destination variable
    
    Returns:
    
    this variable
  - moveTo
```
ICobolVar moveTo(INumericVar dst)
```
    writes the value of this variable into the variable specified by dst
    
    Parameters:
    
    dst - the destination variable
    
    Returns:
    
    this variable
  - moveTo
```
ICobolVar moveTo(IPicNumEdit dst)
```
    writes the value of this variable into the variable specified by dst
    
    Parameters:
    
    dst - the destination variable
    
    Returns:
    
    this variable
  - isDecimalPointComma
```
boolean isDecimalPointComma()
```
    returns true if the decimal point is ','
    
    Specified by:
    
    isDecimalPointComma in interface CobValue
  - isInDynamicTable
```
boolean isInDynamicTable()
```
    for internal use only
  - isDynamicLength
```
boolean isDynamicLength()
```
    returns true if the variable is a group-item and it contains OCCURS DYNAMIC or ANY LENGTH variables
  - hasDynamicData
```
boolean hasDynamicData()
```
    returns true if isDynamicLength() returns true and at least one dynamic variable has a length greater than 0.
  - getOId
```
Object getOId()
```
    for internal use only
  - setOId
```
void setOId(Object oid)
```
    for internal use only
  - getName
```
String getName()
```
    returns the cobol name of the variable
  - initialize
```
void initialize(int[] categories,
                ICobolVar[] src,
                boolean withFiller)
```
    for internal use only
  - compareTo
```
int compareTo(CobolNum val)
```
    for internal use only
  - getIXMLAttributes
```
IXMLAttributes getIXMLAttributes()
```
    returns the XML attributes associated to this variable
  - link
```
ICobolVar link(ICobolVar v)
```
    for internal use only
  - setByVal
```
ICobolVar setByVal(boolean bv)
```
    for internal use only
  - existsDynamicElement
```
boolean existsDynamicElement(int[] idxs)
```
    for internal use only
  - getDynamicCapacity
```
int getDynamicCapacity(int[] idxs)
```
    for internal use only
  - getDynamicCapacity
```
int getDynamicCapacity(int[] idxs,
                       boolean recur)
```
    for internal use only
  - dynSet
```
void dynSet(ICobolVar src)
```
    for internal use only
  - xmlClone
```
ICobolVar xmlClone()
```
    for internal use only
  - toStringNoGui
```
String toStringNoGui()
```
    for internal use only

Interface ICobolVar

Field Summary

Method Summary

Methods inherited from interface com.iscobol.rts.CobValue

Field Detail

LIKE_NOT_CS

LIKE_L_TRIM

LIKE_R_TRIM

LIKE_TRIM

Method Detail

set

set

set

set

set

set

set

set

set

set

set

set

set

setUsingMaxLen

setValue

setSpace

compare

getRedefines

getChildren

toboolean

tobyte

tochar

toshort

toint

tolong

tofloat

todouble

getLength

length

getMemoryLength

getMaxLength

isFinal

basicToString

getDimensions

getLastDimension

getType

getOffset

intIAt

intIAt

intIAtNoClone

intICopy

intISub

intISub

intIOffs

getMaxDimension

getDependingOn

getDependingDelta

getBytes

getBytes

getIParent

moveTo

moveTo

moveTo

isDecimalPointComma

isInDynamicTable

isDynamicLength

hasDynamicData

getOId

setOId

getName

initialize

compareTo

getIXMLAttributes

link

setByVal

existsDynamicElement

getDynamicCapacity

getDynamicCapacity

dynSet

xmlClone