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

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

public interface UnstringStmt
extends Stmt

A representation of an UNSTRING statement in the PROCEDURE division.

The following features are supported:

See Also:
COBOLPackage.getUnstringStmt()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 UnstringDelimitedClause getDelimitedClause()
          Returns the value of the 'Delimited Clause' containment reference.
 java.util.List getIntoClauses()
          Returns the value of the 'Into Clauses' containment reference list.
 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 getRef()
          Returns the value of the 'Ref' containment reference.
 DataRef getTallyingIn()
          Returns the value of the 'Tallying In' containment reference.
 DataRef getWithPointer()
          Returns the value of the 'With Pointer' containment reference.
 boolean isEndUnstringUsed()
          Returns the value of the 'End Unstring Used' attribute.
 void setDelimitedClause(UnstringDelimitedClause value)
          Sets the value of the 'Delimited Clause' containment reference.
 void setEndUnstringUsed(boolean value)
          Sets the value of the 'End Unstring Used' attribute.
 void setRef(DataRef value)
          Sets the value of the 'Ref' containment reference.
 void setTallyingIn(DataRef value)
          Sets the value of the 'Tallying In' 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

getRef

DataRef getRef()
Returns the value of the 'Ref' containment reference.

The value is the sending field.

Returns:
the value of the 'Ref' containment reference.
See Also:
setRef(DataRef), COBOLPackage.getUnstringStmt_Ref()

setRef

void setRef(DataRef value)
Sets the value of the 'Ref' containment reference.

Parameters:
value - the new value of the 'Ref' containment reference.
See Also:
getRef()

getDelimitedClause

UnstringDelimitedClause getDelimitedClause()
Returns the value of the 'Delimited Clause' containment reference.

Returns:
the value of the 'Delimited Clause' containment reference.
See Also:
setDelimitedClause(UnstringDelimitedClause), COBOLPackage.getUnstringStmt_DelimitedClause()

setDelimitedClause

void setDelimitedClause(UnstringDelimitedClause value)
Sets the value of the 'Delimited Clause' containment reference.

Parameters:
value - the new value of the 'Delimited Clause' containment reference.
See Also:
getDelimitedClause()

getIntoClauses

java.util.List getIntoClauses()
Returns the value of the 'Into Clauses' containment reference list. The list contents are of type UnstringIntoClause.

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

getWithPointer

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

The value is the data item in the WITH POINTER clause.

Returns:
the value of the 'With Pointer' containment reference.
See Also:
setWithPointer(DataRef), COBOLPackage.getUnstringStmt_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()

getTallyingIn

DataRef getTallyingIn()
Returns the value of the 'Tallying In' containment reference.

The value is the data item in the TALLYING IN clause.

Returns:
the value of the 'Tallying In' containment reference.
See Also:
setTallyingIn(DataRef), COBOLPackage.getUnstringStmt_TallyingIn()

setTallyingIn

void setTallyingIn(DataRef value)
Sets the value of the 'Tallying In' containment reference.

Parameters:
value - the new value of the 'Tallying In' containment reference.
See Also:
getTallyingIn()

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 statement in the ON OVERFLOW clause.

Returns:
the value of the 'On Overflow' containment reference list.
See Also:
COBOLPackage.getUnstringStmt_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 clause.

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

isEndUnstringUsed

boolean isEndUnstringUsed()
Returns the value of the 'End Unstring Used' attribute.

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

Returns:
the value of the 'End Unstring Used' attribute.
See Also:
setEndUnstringUsed(boolean), COBOLPackage.getUnstringStmt_EndUnstringUsed()

setEndUnstringUsed

void setEndUnstringUsed(boolean value)
Sets the value of the 'End Unstring Used' attribute.

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