Result (dark-matter 3.1.15 API)

java.lang.Object
- org.dmd.util.exceptions.Result

```
public class Result
extends Object
```
This class provides a mechanism to indicate a variety of error and/or warning information back to a caller.
Unlike an exception, an Result can be used to reflect a much more detailed set of information back to a calling routine. It is especially useful for interfaces that involve interaction with a user. When used in conjunction with the ResultSet class, this class can be used to send back several error or warning indications based on a single call to a routine.

See Also:

ResultSet

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CAT_COMMS` Indicates that the response is related to communications.
`static int`	`CAT_DATABASE` Indicates that the response is related to the database.
`static int`	`CAT_OPERATIONAL` Indicates that the response is related to an operation.
`static int`	`CAT_SECURITY` Indicates that the response is related to security.
`static int`	`CAT_SOFTWARE` Indicates that the response is related to software.
`static int`	`ERROR` Indicates that a definite error has occurred; proceed at your own risk!
`static int`	`FATAL` Indicates that the error is so serious that you should cease whatever operation you're performing.
`static int`	`INFO` Indicates that the result is merely informational; nothing serious.
`static int`	`NONE` Indicates that no severity information has been set.
`static int`	`WARNING` Indicates that a problem was encountered but it's just a warning.

Constructor Summary

Constructors
Constructor and Description

Result(Result r)
Creates a new RResult container from an existing one.

Constructors
Constructor and Description
`Result(Result r)` Creates a new RResult container from an existing one.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`attrName()` Returns the attribute name.
`void`	`attrName(String s)` Sets the attribute name.
`int`	`category()` Returns the category.
`void`	`category(int c)` Sets the category.
`String`	`fileName()` Returns the file name.
`void`	`fileName(String s)` Sets the file name.
`int`	`lineNumber()` Returns the line number.
`void`	`lineNumber(int i)` Sets the line number.
`String`	`message()` Returns the message text.
`void`	`message(String s)` Sets the message text.
`ArrayList<StringBuffer>`	`moreMessages()` Returns the additional message text as an ArrayList of StringBuffers.
`void`	`moreMessages(String s)` Adds additional message text to the result.
`int`	`nearLineNumber()` Returns the approximate line number.
`void`	`nearLineNumber(int i)` Sets the approximate line number.
`void`	`reset()` Resets the result to contain no information.
`void`	`reset(int sev, String txt)` Resets the result to the specified severity with the specified text.
`int`	`severity()` Returns the severity.
`void`	`severity(int s)` Sets the severity.
`String`	`toString()` Returns the result as a nicely formatted string.
`int`	`uniqueID()` Returns the unique message identifier.
`void`	`uniqueID(int i)` Sets the unique message identifier.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NONE
```
public static final int NONE
```
    Indicates that no severity information has been set.
    
    See Also:
    
    Constant Field Values
  - INFO
```
public static final int INFO
```
    Indicates that the result is merely informational; nothing serious.
    
    See Also:
    
    Constant Field Values
  - WARNING
```
public static final int WARNING
```
    Indicates that a problem was encountered but it's just a warning.
    
    See Also:
    
    Constant Field Values
  - ERROR
```
public static final int ERROR
```
    Indicates that a definite error has occurred; proceed at your own risk!
    
    See Also:
    
    Constant Field Values
  - FATAL
```
public static final int FATAL
```
    Indicates that the error is so serious that you should cease whatever operation you're performing.
    
    See Also:
    
    Constant Field Values
  - CAT_SOFTWARE
```
public static final int CAT_SOFTWARE
```
    Indicates that the response is related to software.
    
    See Also:
    
    Constant Field Values
  - CAT_SECURITY
```
public static final int CAT_SECURITY
```
    Indicates that the response is related to security.
    
    See Also:
    
    Constant Field Values
  - CAT_DATABASE
```
public static final int CAT_DATABASE
```
    Indicates that the response is related to the database.
    
    See Also:
    
    Constant Field Values
  - CAT_COMMS
```
public static final int CAT_COMMS
```
    Indicates that the response is related to communications.
    
    See Also:
    
    Constant Field Values
  - CAT_OPERATIONAL
```
public static final int CAT_OPERATIONAL
```
    Indicates that the response is related to an operation.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Result
```
public Result(Result r)
```
    Creates a new RResult container from an existing one.
- Method Detail
  - reset
```
public void reset()
```
    Resets the result to contain no information.
  - reset
```
public void reset(int sev,
                  String txt)
```
    Resets the result to the specified severity with the specified text.
  - severity
```
public int severity()
```
    Returns the severity.
  - category
```
public int category()
```
    Returns the category.
  - severity
```
public void severity(int s)
```
    Sets the severity.
  - category
```
public void category(int c)
```
    Sets the category.
  - message
```
public String message()
```
    Returns the message text.
  - message
```
public void message(String s)
```
    Sets the message text.
  - moreMessages
```
public ArrayList<StringBuffer> moreMessages()
```
    Returns the additional message text as an ArrayList of StringBuffers. The number of additional lines is available via the moreCount() method.
  - moreMessages
```
public void moreMessages(String s)
```
    Adds additional message text to the result.
  - fileName
```
public String fileName()
```
    Returns the file name.
  - fileName
```
public void fileName(String s)
```
    Sets the file name.
  - lineNumber
```
public int lineNumber()
```
    Returns the line number.
  - lineNumber
```
public void lineNumber(int i)
```
    Sets the line number. You can only call lineNumber() or nearLineNumber() for an RResult; you can't use both at the same time. You either know the exact line number or you don't.
  - nearLineNumber
```
public int nearLineNumber()
```
    Returns the approximate line number.
  - nearLineNumber
```
public void nearLineNumber(int i)
```
    Sets the approximate line number. You can only call lineNumber() or nearLineNumber() for an RResult; you can't use both at the same time. You either know the exact line number or you don't.
  - attrName
```
public String attrName()
```
    Returns the attribute name.
  - attrName
```
public void attrName(String s)
```
    Sets the attribute name.
  - uniqueID
```
public int uniqueID()
```
    Returns the unique message identifier.
  - uniqueID
```
public void uniqueID(int i)
```
    Sets the unique message identifier.
  - toString
```
public String toString()
```
    Returns the result as a nicely formatted string.
    
    Overrides:
    
    toString in class Object

Class Result

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NONE

INFO

WARNING

ERROR

FATAL

CAT_SOFTWARE

CAT_SECURITY

CAT_DATABASE

CAT_COMMS

CAT_OPERATIONAL

Constructor Detail

Result

Method Detail

reset

reset

severity

category

severity

category

message

message

moreMessages

moreMessages

fileName

fileName

lineNumber

lineNumber

nearLineNumber

nearLineNumber

attrName

attrName

uniqueID

uniqueID

toString