org.prorefactor.macrolevel
Class IncludeRef

java.lang.Object
  org.prorefactor.macrolevel.MacroRef
      org.prorefactor.macrolevel.IncludeRef

All Implemented Interfaces:

Xferable, java.io.Serializable, MacroEvent

public class IncludeRef
extends MacroRef

See Also:

Serialized Form

Field Summary

int	fileIndex
boolean	usesNamedArgs

Fields inherited from class org.prorefactor.macrolevel.MacroRef

macroEventList, parent, refColumn, refLine

Constructor Summary

IncludeRef()
Only to be used for persistence/serialization.

Method Summary

void	addNamedArg(MacroDef arg)
void	addNumberedArg(MacroDef arg)
MacroDef	getArgNumber(int num) Count from 1, the way that the arguments are referenced in ABL.
int	getFileIndex()
java.lang.String	getFileRefName() Get the string that was used for referencing the include file name.
MacroDef	lookupNamedArg(java.lang.String name)
int	numArgs()
void	setFileRefName(java.lang.String fileRefName)
MacroDef	undefine(java.lang.String name)
void	writeXferBytes(DataXferStream out) Implement Xferable.
void	writeXferSchema(DataXferStream out) Implement Xferable.

Methods inherited from class org.prorefactor.macrolevel.MacroRef

findExternalMacroReferences, findExternalMacroReferences, findIncludeReferences, getListingFileLine, getParent, getPosition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

usesNamedArgs

public boolean usesNamedArgs

fileIndex

public int fileIndex

Constructor Detail

IncludeRef

public IncludeRef()

Only to be used for persistence/serialization.

Method Detail

addNamedArg

public void addNamedArg(MacroDef arg)

addNumberedArg

public void addNumberedArg(MacroDef arg)

getArgNumber

public MacroDef getArgNumber(int num)

Count from 1, the way that the arguments are referenced in ABL.

getFileIndex

public int getFileIndex()

Specified by:

getFileIndex in class MacroRef

getFileRefName

public java.lang.String getFileRefName()

Get the string that was used for referencing the include file name. For example, if the code was {includeMe.i}, then the string "includeMe.i" is returned. Note: For Proparse versions earlier than 3.1C, this will return and empty string.

lookupNamedArg

public MacroDef lookupNamedArg(java.lang.String name)

numArgs

public int numArgs()

setFileRefName

public void setFileRefName(java.lang.String fileRefName)

undefine

public MacroDef undefine(java.lang.String name)

writeXferBytes

public void writeXferBytes(DataXferStream out)
                    throws java.io.IOException

Implement Xferable.

Specified by:

writeXferBytes in interface Xferable

Overrides:

writeXferBytes in class MacroRef

Throws:

java.io.IOException

writeXferSchema

public void writeXferSchema(DataXferStream out)
                     throws java.io.IOException

Implement Xferable.

Specified by:

writeXferSchema in interface Xferable

Overrides:

writeXferSchema in class MacroRef

Throws:

java.io.IOException