com.ibm.etools.cobol.application.model.cobol
Interface StringStmt

All Superinterfaces:
ASTNode, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier, Stmt

public interface StringStmt
extends Stmt

A representation of a STRING statement in the PROCEDURE division.

The following features are supported:

See Also:
COBOLPackage.getStringStmt()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.util.List getClauses()
          Returns the value of the 'Clauses' containment reference list.
 DataRef getInto()
          Returns the value of the 'Into' containment reference.
 java.util.List getNotOnOverflow()
          Returns the value of the 'Not On Overflow' containment reference list.
 java.util.List getOnOverflow()
          Returns the value of the 'On Overflow' containment reference list.
 DataRef getWithPointer()
          Returns the value of the 'With Pointer' containment reference.
 boolean isEndStringUsed()
          Returns the value of the 'End String Used' attribute.
 void setEndStringUsed(boolean value)
          Sets the value of the 'End String Used' attribute.
 void setInto(DataRef value)
          Sets the value of the 'Into' containment reference.
 void setWithPointer(DataRef value)
          Sets the value of the 'With Pointer' containment reference.
 
Methods inherited from interface com.ibm.etools.cobol.application.model.cobol.ASTNode
getBeginColumn, getBeginFile, getBeginLine, getEndColumn, getEndFile, getEndLine, getParent, getTag, setBeginColumn, setBeginFile, setBeginLine, setEndColumn, setEndFile, setEndLine, setParent, setTag
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getClauses

java.util.List getClauses()
Returns the value of the 'Clauses' containment reference list. The list contents are of type StringClause.

The list contains the sending fields.

Returns:
the value of the 'Clauses' containment reference list.
See Also:
COBOLPackage.getStringStmt_Clauses()

getInto

DataRef getInto()
Returns the value of the 'Into' containment reference.

The value is the data item specified after the INTO keyword.

Returns:
the value of the 'Into' containment reference.
See Also:
setInto(DataRef), COBOLPackage.getStringStmt_Into()

setInto

void setInto(DataRef value)
Sets the value of the 'Into' containment reference.

Parameters:
value - the new value of the 'Into' containment reference.
See Also:
getInto()

getWithPointer

DataRef getWithPointer()
Returns the value of the 'With Pointer' containment reference.

The value is the data item specified after the WITH POINTER keywords.

Returns:
the value of the 'With Pointer' containment reference.
See Also:
setWithPointer(DataRef), COBOLPackage.getStringStmt_WithPointer()

setWithPointer

void setWithPointer(DataRef value)
Sets the value of the 'With Pointer' containment reference.

Parameters:
value - the new value of the 'With Pointer' containment reference.
See Also:
getWithPointer()

getOnOverflow

java.util.List getOnOverflow()
Returns the value of the 'On Overflow' containment reference list. The list contents are of type Stmt.

The list contains the statements in the ON OVERFLOW phrase.

Returns:
the value of the 'On Overflow' containment reference list.
See Also:
COBOLPackage.getStringStmt_OnOverflow()

getNotOnOverflow

java.util.List getNotOnOverflow()
Returns the value of the 'Not On Overflow' containment reference list. The list contents are of type Stmt.

The list contains the statements in the NOT ON OVERFLOW phrase.

Returns:
the value of the 'Not On Overflow' containment reference list.
See Also:
COBOLPackage.getStringStmt_NotOnOverflow()

isEndStringUsed

boolean isEndStringUsed()
Returns the value of the 'End String Used' attribute.

The value is true if END-STRING is present; false otherwise.

Returns:
the value of the 'End String Used' attribute.
See Also:
setEndStringUsed(boolean), COBOLPackage.getStringStmt_EndStringUsed()

setEndStringUsed

void setEndStringUsed(boolean value)
Sets the value of the 'End String Used' attribute.

Parameters:
value - the new value of the 'End String Used' attribute.
See Also:
isEndStringUsed()