org.dmd.dmc.rules

Class SourceInfo

java.lang.Object

org.dmd.dmc.rules.SourceInfo

public class SourceInfo
extends Object

The SourceInfo class is used to store information about the origin of an object against which rules are applied. It's all very well to be able to thrown an exception from a rule to indicate that something is wrong, but if you don't know the source of the object, it's hard to know where you need to fix it.

Not all information that can be represented in a SourceInfo item is necessarily available all the time.

If you require further source information than what is available here, simply derive your own class and add the information you require and overload the toString() method.

Constructor Summary

Constructors

Constructor and Description
SourceInfo(String sess, DmcObject obj) Used to create source information associated with a remote session that is doing something with the object to which rules are being applied.
SourceInfo(String fn, int ln) Used to create source information about an object that was defined at a known location, but not much else is available.
SourceInfo(String fn, String ln) Used to create source information about an object that was defined at a known location, but not much else is available.
SourceInfo(String fn, String ln, DmcObject obj) Used to create source information about an object that has been read from a file.

Method Summary

Modifier and Type	Method and Description
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceInfo

public SourceInfo(String fn,
                  String ln,
                  DmcObject obj)

Used to create source information about an object that has been read from a file. If the object is named, its name is extracted.

Parameters:

fn - The file name

ln - The line number.

obj - The object.

SourceInfo

public SourceInfo(String sess,
                  DmcObject obj)

Used to create source information associated with a remote session that is doing something with the object to which rules are being applied. If the object is named, its name is extracted.

Parameters:

sess - A string representation of the session information.

obj - The object being altered.

SourceInfo

public SourceInfo(String fn,
                  String ln)

Used to create source information about an object that was defined at a known location, but not much else is available. This can happen, for instance, with rule objects that haven't yet been validated.

Parameters:

fn - The file name

ln - The line number.

SourceInfo

public SourceInfo(String fn,
                  int ln)

Used to create source information about an object that was defined at a known location, but not much else is available. This can happen, for instance, with rule objects that haven't yet been validated.

Parameters:

fn - The file name

ln - The line number.

Method Detail

toString

public String toString()

Overrides:

toString in class Object