SBMLError

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - java.lang.RuntimeException
    - - org.sbml.jsbml.xml.XMLException
      - org.sbml.jsbml.SBMLError

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

LevelVersionError, PropertyException, SBMLTypeUndefinedException
```
public class SBMLError
extends XMLException
```
Representation of errors, warnings and other diagnostics.

For more details, see the libSBML SBMLError javadoc

Since:

0.8

Author:

Nicolas Rodriguez, Andreas Dräger

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SBMLError.SEVERITY

Nested Classes
Modifier and Type	Class and Description
`static class`	`SBMLError.SEVERITY`

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`category`
`private int`	`code`
`private int`	`column`
`private Detail`	`detail`
`private java.lang.String`	`excerpt`
`private int`	`line`
`private Message`	`message`
`private java.lang.String`	`packageName`
`private static long`	`serialVersionUID` Generated serial version identifier.
`private java.lang.String`	`severity`
`private Message`	`shortmessage`

Constructor Summary

Constructors
Constructor and Description

SBMLError()
Constructs a new SBMLError.

SBMLError(java.lang.String message)
Constructs a new SBMLError with the given message.

Constructors
Constructor and Description
`SBMLError()` Constructs a new `SBMLError`.
`SBMLError(java.lang.String message)` Constructs a new `SBMLError` with the given message.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCategory()` Returns the category of the `SBMLError`
`int`	`getCode()` Returns the code of this `SBMLError`.
`int`	`getColumn()` Returns the column where this `SBMLError` happened.
`Detail`	`getDetail()`
`java.lang.String`	`getExcerpt()` Returns a fragment of the original XML file that induced the error.
`int`	`getLine()` Returns the line where this `SBMLError` happened.
`java.lang.String`	`getMessage()` Returns the message of the `SBMLError`
`Message`	`getMessageInstance()` Returns the full `Message`.
`java.lang.String`	`getPackage()`
`java.lang.String`	`getSeverity()` Returns the severity of the `SBMLError`
`Message`	`getShortMessage()`
`boolean`	`isError()` Returns `true` is the `SBMLError` severity is of type `SBMLError.SEVERITY.ERROR`
`boolean`	`isFatal()` Returns `true` is the `SBMLError` severity is of type `SBMLError.SEVERITY.FATAL`
`boolean`	`isInfo()` Returns `true` is the `SBMLError` severity is of type `SBMLError.SEVERITY.INFO`
`boolean`	`isInternal()` Returns `true` is the `SBMLError` category is of type `internal`
`boolean`	`isSystem()` Returns `true` is the `SBMLError` category is of type `system`
`boolean`	`isWarning()` Returns `true` is the `SBMLError` severity is of type `SBMLError.SEVERITY.WARNING`
`boolean`	`isXML()` Returns `true` is the `SBMLError` category is of type `xml`
`void`	`setCategory(java.lang.String category)` Sets the category of this `SBMLError`.
`void`	`setCode(int code)` Sets the error code of this `SBMLError`.
`void`	`setColumn(int column)`
`void`	`setDetail(Detail detail)`
`void`	`setExcerpt(java.lang.String excerpt)` Sets the excerpt of this `SBMLError`.
`void`	`setLine(int line)`
`void`	`setMessage(Message message)` Sets the message of this `SBMLError`.
`void`	`setPackage(java.lang.String packageName)`
`void`	`setSeverity(java.lang.String severity)` Sets the severity of this `SBMLError`.
`void`	`setShortMessage(Message shortmessage)`
`java.lang.String`	`toString()`

Methods inherited from class org.sbml.jsbml.xml.XMLException
getErrorId

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    Generated serial version identifier.
    
    See Also:
    
    Constant Field Values
  - category
```
private java.lang.String category
```
  - code
```
private int code
```
  - excerpt
```
private java.lang.String excerpt
```
  - column
```
private int column
```
  - line
```
private int line
```
  - message
```
private Message message
```
  - shortmessage
```
private Message shortmessage
```
  - detail
```
private Detail detail
```
  - severity
```
private java.lang.String severity
```
  - packageName
```
private java.lang.String packageName
```
- Constructor Detail
  - SBMLError
```
public SBMLError()
```
    Constructs a new SBMLError.
  - SBMLError
```
public SBMLError(java.lang.String message)
```
    Constructs a new SBMLError with the given message.
    
    Parameters:
    
    message - the error message
- Method Detail
  - getCategory
```
public java.lang.String getCategory()
```
    Returns the category of the SBMLError
    
    Returns:
    
    the category of the SBMLError
  - getCode
```
public int getCode()
```
    Returns the code of this SBMLError.
    
    Returns:
    
    the code of this SBMLError.
  - getColumn
```
public int getColumn()
```
    Returns the column where this SBMLError happened.
    
    Returns:
    
    the column where this SBMLError happened.
  - getExcerpt
```
public java.lang.String getExcerpt()
```
    Returns a fragment of the original XML file that induced the error.
    
    Returns:
    
    a fragment of the original XML file that induced the error.
  - getLine
```
public int getLine()
```
    Returns the line where this SBMLError happened.
    
    Returns:
    
    the line where this SBMLError happened.
  - getMessageInstance
```
public Message getMessageInstance()
```
    Returns the full Message.
    
    Returns:
    
    the full Message.
  - getMessage
```
public java.lang.String getMessage()
```
    Returns the message of the SBMLError
    
    Overrides:
    
    getMessage in class java.lang.Throwable
    
    Returns:
    
    the message of the SBMLError
  - getSeverity
```
public java.lang.String getSeverity()
```
    Returns the severity of the SBMLError
    
    Returns:
    
    the severity of the SBMLError
  - isFatal
```
public boolean isFatal()
```
    Returns true is the SBMLError severity is of type SBMLError.SEVERITY.FATAL
    
    Returns:
    
    true is the SBMLError severity is of type SBMLError.SEVERITY.FATAL
  - isError
```
public boolean isError()
```
    Returns true is the SBMLError severity is of type SBMLError.SEVERITY.ERROR
    
    Returns:
    
    true is the SBMLError severity is of type SBMLError.SEVERITY.ERROR
  - isInfo
```
public boolean isInfo()
```
    Returns true is the SBMLError severity is of type SBMLError.SEVERITY.INFO
    
    Returns:
    
    true is the SBMLError severity is of type SBMLError.SEVERITY.INFO
  - isWarning
```
public boolean isWarning()
```
    Returns true is the SBMLError severity is of type SBMLError.SEVERITY.WARNING
    
    Returns:
    
    true is the SBMLError severity is of type SBMLError.SEVERITY.WARNING
  - isInternal
```
public boolean isInternal()
```
    Returns true is the SBMLError category is of type internal
    
    Returns:
    
    true is the SBMLError category is of type internal
  - isSystem
```
public boolean isSystem()
```
    Returns true is the SBMLError category is of type system
    
    Returns:
    
    true is the SBMLError category is of type system
  - isXML
```
public boolean isXML()
```
    Returns true is the SBMLError category is of type xml
    
    Returns:
    
    true is the SBMLError category is of type xml
  - setCategory
```
public void setCategory(java.lang.String category)
```
    Sets the category of this SBMLError.
    
    Parameters:
    
    category -
  - setCode
```
public void setCode(int code)
```
    Sets the error code of this SBMLError.
    
    Parameters:
    
    code -
  - setExcerpt
```
public void setExcerpt(java.lang.String excerpt)
```
    Sets the excerpt of this SBMLError.
    
    Parameters:
    
    excerpt -
  - setMessage
```
public void setMessage(Message message)
```
    Sets the message of this SBMLError.
    
    Parameters:
    
    message -
  - setSeverity
```
public void setSeverity(java.lang.String severity)
```
    Sets the severity of this SBMLError.
    
    Parameters:
    
    severity -
  - getShortMessage
```
public Message getShortMessage()
```
    Returns:
  - setShortMessage
```
public void setShortMessage(Message shortmessage)
```
    Parameters:
    
    shortmessage -
  - getDetail
```
public Detail getDetail()
```
    Returns:
  - setDetail
```
public void setDetail(Detail detail)
```
    Parameters:
    
    detail -
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Throwable
  - setColumn
```
public void setColumn(int column)
```
    Parameters:
    
    column -
  - setLine
```
public void setLine(int line)
```
    Parameters:
    
    line -
  - setPackage
```
public void setPackage(java.lang.String packageName)
```
    Parameters:
    
    packageName -
  - getPackage
```
public java.lang.String getPackage()
```
    Returns:

Class SBMLError

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.sbml.jsbml.xml.XMLException

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

category

code

excerpt

column

line

message

shortmessage

detail

severity

packageName

Constructor Detail

SBMLError

SBMLError

Method Detail

getCategory

getCode

getColumn

getExcerpt

getLine

getMessageInstance

getMessage

getSeverity

isFatal

isError

isInfo

isWarning

isInternal

isSystem

isXML

setCategory

setCode

setExcerpt

setMessage

setSeverity

getShortMessage

setShortMessage

getDetail

setDetail

toString

setColumn

setLine

setPackage

getPackage