java.lang.Object
- uk.ac.ebi.pride.jmztab2.utils.errors.MZTabErrorList

```
public class MZTabErrorList
extends java.lang.Object
```
A limit max capacity list, if contains a couple of MZTabError objects. If overflow, system will raise MZTabErrorOverflowException. Besides this, during add a new MZTabError object, it's MZTabErrorType.level SHOULD equal or great than its level setting.

Since:

29/01/13

Author:

qingwei

Constructor Summary

Constructors
Constructor	Description
`MZTabErrorList()`	Generate a error list, which max size is `MZTabProperties.MAX_ERROR_COUNT`, and only allow `MZTabErrorType.Level.Error` or greater level errors to be added into list.
`MZTabErrorList(MZTabErrorType.Level level)`	Generate a error list, which max size is `MZTabProperties.MAX_ERROR_COUNT`
`MZTabErrorList(MZTabErrorType.Level level, int maxErrorCount)`	Generate a error list, with given error level and maximum error count.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`add(MZTabError error)`	A limit max capacity list, if contains a couple of `MZTabError` objects.
`void`	`clear()`	Clear all errors stored in the error list.
`java.util.List<ValidationMessage>`	`convertToValidationMessages()`	Converts this error list to a list of validation messages.
`static java.util.List<ValidationMessage>`	`convertToValidationMessages(MZTabErrorList errorList)`	Converts the provided error list to a list of validation messages.
`MZTabError`	`getError(int index)`	Returns the element at the specified position in this list.
`java.util.List<MZTabError>`	`getErrorList()`	Unmodifiable list of errors
`MZTabErrorType.Level`	`getLevel()`	Getter for the field `level`.
`int`	`getMaxErrorCount()`	Getter for the field `maxErrorCount`.
`boolean`	`isEmpty()`	Returns `true` if this list contains no elements.
`void`	`print(java.io.OutputStream out)`	Print error list to output stream.
`void`	`setLevel(MZTabErrorType.Level level)`	Define the level of the errors that are going to be store in the list.
`void`	`setMaxErrorCount(int maxErrorCount)`	Define the maximum number of errors recorded by this list before an `MZTabErrorOverflowException` is thrown
`int`	`size()`	Returns the number of elements in this list.
`java.lang.String`	`toString()`	Print error list to string.

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

- Constructor Detail
  - MZTabErrorList
```
public MZTabErrorList()
```
    Generate a error list, which max size is MZTabProperties.MAX_ERROR_COUNT, and only allow MZTabErrorType.Level.Error or greater level errors to be added into list.
  - MZTabErrorList
```
public MZTabErrorList(MZTabErrorType.Level level)
```
    Generate a error list, which max size is MZTabProperties.MAX_ERROR_COUNT
    
    Parameters:
    
    level - if null, default level is MZTabErrorType.Level.Error
  - MZTabErrorList
```
public MZTabErrorList(MZTabErrorType.Level level,
                      int maxErrorCount)
```
    Generate a error list, with given error level and maximum error count.
    
    Parameters:
    
    level - if null, default level is MZTabErrorType.Level.Error
    
    maxErrorCount - the maximum number of errors recorded by this list before an MZTabErrorOverflowException is thrown
- Method Detail
  - getErrorList
```
public java.util.List<MZTabError> getErrorList()
```
    Unmodifiable list of errors
    
    Returns:
    
    error list
  - add
```
public boolean add(MZTabError error)
            throws MZTabErrorOverflowException
```
    A limit max capacity list, if contains a couple of MZTabError objects. If overflow, system will raise MZTabErrorOverflowException. Besides this, during add a new MZTabError object, it's MZTabErrorType.level SHOULD equal or greater than its level setting.
    
    Parameters:
    
    error - SHOULD NOT set null
    
    Returns:
    
    a boolean.
    
    Throws:
    
    MZTabErrorOverflowException - if any.
  - getMaxErrorCount
```
public int getMaxErrorCount()
```
    Getter for the field maxErrorCount.
    
    Returns:
    
    The maximum number of errors that are going to be reported before the parser stops with an MZTabErrorOverflowException
  - setMaxErrorCount
```
public void setMaxErrorCount(int maxErrorCount)
```
    Define the maximum number of errors recorded by this list before an MZTabErrorOverflowException is thrown
    
    Parameters:
    
    maxErrorCount - needs to be a positive number or zero will be set
  - getLevel
```
public MZTabErrorType.Level getLevel()
```
    Getter for the field level.
    
    Returns:
    
    level of errors reported MZTabErrorType.level
  - setLevel
```
public void setLevel(MZTabErrorType.Level level)
```
    Define the level of the errors that are going to be store in the list. The incoming errors with an equal or highest level will be stored.
    
    Parameters:
    
    level - MZTabErrorType.level
  - clear
```
public void clear()
```
    Clear all errors stored in the error list.
  - size
```
public int size()
```
    Returns the number of elements in this list.
    
    Returns:
    
    a int.
  - getError
```
public MZTabError getError(int index)
```
    Returns the element at the specified position in this list.
    
    Parameters:
    
    index - index of the element to return
    
    Returns:
    
    a MZTabError object.
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this list contains no elements.
    
    Returns:
    
    a boolean.
  - print
```
public void print(java.io.OutputStream out)
           throws java.io.IOException
```
    Print error list to output stream.
    
    Parameters:
    
    out - SHOULD NOT set null.
    
    Throws:
    
    java.io.IOException - if any.
  - toString
```
public java.lang.String toString()
```
    Print error list to string.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String object.
  - convertToValidationMessages
```
public static java.util.List<ValidationMessage> convertToValidationMessages(MZTabErrorList errorList)
                                                                     throws java.lang.IllegalStateException
```
    Converts the provided error list to a list of validation messages.
    
    Parameters:
    
    errorList - the error list to convert.
    
    Returns:
    
    a list of validation messages.
    
    Throws:
    
    java.lang.IllegalStateException - for unhandled mappings of ValidationMessage.MessageTypeEnum.
  - convertToValidationMessages
```
public java.util.List<ValidationMessage> convertToValidationMessages()
                                                              throws java.lang.IllegalStateException
```
    Converts this error list to a list of validation messages.
    
    Returns:
    
    a list of validation messages.
    
    Throws:
    
    java.lang.IllegalStateException - for unhandled mappings of ValidationMessage.MessageTypeEnum.

Class MZTabErrorList

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MZTabErrorList

MZTabErrorList

MZTabErrorList

Method Detail

getErrorList

add

getMaxErrorCount

setMaxErrorCount

getLevel

setLevel

clear

size

getError

isEmpty

print

toString

convertToValidationMessages

convertToValidationMessages