scriptinterface.execution

Class CallMetadata

java.lang.Object

scriptinterface.execution.CallMetadata

public class CallMetadata
extends java.lang.Object

Stores the meta data of a call.

Constructor Summary

Constructors

Constructor and Description
CallMetadata(ReaderInterface source, int sourcePosition) Constructs a new CallMetadata using the given source and the source position.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getAbsSourcePosition() Returns the absolute character position of the call where line breaks count as one (or two, respectively) characters.
SourcePosition	getFilePosition() Returns line and column of the call.
java.lang.String	getInputKey() Returns the input key of the call.
java.lang.String	getScriptFile() Returns the script file in which the call took place.
java.lang.String	getStringRepresentation() Returns a user-readable string representation of the call meta data.
boolean	hasInputKey() Tells whether or not an input key was set.
CallMetadata	setInputKey(java.lang.String inputKey, boolean allowOverwrite) Sets the input key of the call.
void	setLocation(ReaderInterface source, int sourcePosition) Sets the reference to the source code and the position (in characters) of the call
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CallMetadata

public CallMetadata(ReaderInterface source,
                    int sourcePosition)

Constructs a new CallMetadata using the given source and the source position.

Parameters:

source - a reference to the source code in which the call took place.

sourcePosition - the character position at which the call took place.

Method Detail

getInputKey

public java.lang.String getInputKey()

Returns the input key of the call.

Returns:

the input key.

getScriptFile

public java.lang.String getScriptFile()

Returns the script file in which the call took place.

Returns:

the script file or null, if the call was not done within a file.

setInputKey

public CallMetadata setInputKey(java.lang.String inputKey,
                                boolean allowOverwrite)

Sets the input key of the call.

Parameters:

inputKey - the input key of the call.

allowOverwrite - if true, then another call of setInputKey overwrites the key. If false, then further calls of setInputKey have no effect.

Returns:

this instance.

setLocation

public void setLocation(ReaderInterface source,
                        int sourcePosition)

Sets the reference to the source code and the position (in characters) of the call

Parameters:

source - a reference to the source code

sourcePosition - the character position of the call

getAbsSourcePosition

public java.lang.Integer getAbsSourcePosition()

Returns the absolute character position of the call where line breaks count as one (or two, respectively) characters.

Returns:

the absolute character position of the call.

getFilePosition

public SourcePosition getFilePosition()

Returns line and column of the call.

Returns:

line and column as SourcePosition.

hasInputKey

public boolean hasInputKey()

Tells whether or not an input key was set.

Returns:

true iff an input key was set.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStringRepresentation

public java.lang.String getStringRepresentation()

Returns a user-readable string representation of the call meta data.

Returns:

the string representation of the call.