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

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

public interface ReturnStmt
extends Stmt

A representation of a RETURN statement in the PROCEDURE division.

The following features are supported:

See Also:
COBOLPackage.getReturnStmt()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.util.List getAtEnd()
          Returns the value of the 'At End' containment reference list.
 FileDescriptionEntry getFile()
          Returns the value of the 'File' reference.
 DataRef getInto()
          Returns the value of the 'Into' containment reference.
 java.util.List getNotAtEnd()
          Returns the value of the 'Not At End' containment reference list.
 boolean isEndReturnUsed()
          Returns the value of the 'End Return Used' attribute.
 void setEndReturnUsed(boolean value)
          Sets the value of the 'End Return Used' attribute.
 void setFile(FileDescriptionEntry value)
          Sets the value of the 'File' reference.
 void setInto(DataRef value)
          Sets the value of the 'Into' 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

getFile

FileDescriptionEntry getFile()
Returns the value of the 'File' reference.

Returns:
the value of the 'File' reference.
See Also:
setFile(FileDescriptionEntry), COBOLPackage.getReturnStmt_File()

setFile

void setFile(FileDescriptionEntry value)
Sets the value of the 'File' reference.

Parameters:
value - the new value of the 'File' reference.
See Also:
getFile()

getInto

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

The value is the data item in the INTO clause.

Returns:
the value of the 'Into' containment reference.
See Also:
setInto(DataRef), COBOLPackage.getReturnStmt_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()

getAtEnd

java.util.List getAtEnd()
Returns the value of the 'At End' containment reference list. The list contents are of type Stmt.

The list contains the statements in the AT END clause.

Returns:
the value of the 'At End' containment reference list.
See Also:
COBOLPackage.getReturnStmt_AtEnd()

getNotAtEnd

java.util.List getNotAtEnd()
Returns the value of the 'Not At End' containment reference list. The list contents are of type Stmt.

The list contains the statements in the NOT AT END clause.

Returns:
the value of the 'Not At End' containment reference list.
See Also:
COBOLPackage.getReturnStmt_NotAtEnd()

isEndReturnUsed

boolean isEndReturnUsed()
Returns the value of the 'End Return Used' attribute.

The value is true if END-RETURN is used; false otherwise.

Returns:
the value of the 'End Return Used' attribute.
See Also:
setEndReturnUsed(boolean), COBOLPackage.getReturnStmt_EndReturnUsed()

setEndReturnUsed

void setEndReturnUsed(boolean value)
Sets the value of the 'End Return Used' attribute.

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