org.xmcda

Class ProgramExecutionResult

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Message>

org.xmcda.ProgramExecutionResult

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Message>, Collection<Message>, List<Message>, RandomAccess, CommonAttributes, HasDescription, XMCDARootElement

public class ProgramExecutionResult
extends ArrayList<Message>
implements HasDescription, CommonAttributes, Serializable, XMCDARootElement

The result of the execution of a program is defined by:

• its global getStatus() status,
• a list of @{link messages.

Its status is normally deduced during the lifespan of this object:

• it starts with the default value OK;
• its seriouness is elevated to WARNING as soon as a warning message is added;
• last, it is set to ERROR the first time an error message is added.

When using the different methods addDebug(String), addInfo(String), addWarning(String) and addError(String), the status code never "goes back". More formally, status codes are ordered like this: OK < WARNING < ERROR < TERMINATED; its value always goes up, e.g. from OK to ERROR but never fall back to a smaller value.

The TERMINATED value has a special behaviour: it can only be set (or replaced by an other status) by using forceStatus(Status). It is intended to signal that the program has been terminated by an external mean, when possible (for example after receiving a signal from the operating system, or terminated by the user, etc.). xmcda:type:executionResult

Author:

Sébastien Bigaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProgramExecutionResult.Status This enumerates the statuses that a program execution result can have.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ProgramExecutionResult() Builds a new object with no messages and a status equal to OK.

Method Summary

Modifier and Type	Method and Description
Message	addDebug(String text)
Message	addError(String text)
Message	addInfo(String text)
protected Message	addMessage(Message.Level level, String text) Adds a message to this object, along with its the degree of seriousness
Message	addWarning(String text)
void	forceStatus(ProgramExecutionResult.Status newStatus) Do not make any checks and force the object's status to the one supplied. WARNING! Unless you have very good reason, you probably want to use updateStatus(Status).
Description	getDescription()
ProgramExecutionResult.Status	getStatus() Return the status of this execution result
String	id()
boolean	isError() Equivalent to getStatus().equals(Status.ERROR)
boolean	isOk() Equivalent to getStatus().equals(Status.OK)
boolean	isTerminated() Equivalent to getStatus().equals(Status.TERMINATED)
boolean	isWarning() Equivalent to getStatus().equals(Status.WARNING)
String	mcdaConcept()
String	name()
ProgramExecutionResult.Status	refreshStatus() Examine all messages and set the appropriate status, except when the status is already set to TERMINATED, in which case it is left unchanged.
void	setDescription(Description description)
void	setId(String id)
void	setMcdaConcept(String mcdaConcept)
void	setName(String name)
void	updateStatus(ProgramExecutionResult.Status status) Updates the status of this execution results.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Field Detail

TAG

public static final String TAG

See Also:

Constant Field Values

Constructor Detail

ProgramExecutionResult

public ProgramExecutionResult()

Builds a new object with no messages and a status equal to OK.

Method Detail

getStatus

public ProgramExecutionResult.Status getStatus()

Return the status of this execution result

Returns:

the status of this execution result

updateStatus

public void updateStatus(ProgramExecutionResult.Status status)
                  throws NullPointerException

Updates the status of this execution results.

Parameters:

status - the proposed status. It must not be null.

Throws:

NullPointerException - if status is null.

refreshStatus

public ProgramExecutionResult.Status refreshStatus()

Examine all messages and set the appropriate status, except when the status is already set to TERMINATED, in which case it is left unchanged. It must be called if this list of messages is modified, to reflect the changes.

Returns:

The updated status, or ProgramExecutionResult.Status.TERMINATED when it already has this value.

forceStatus

public void forceStatus(ProgramExecutionResult.Status newStatus)
                 throws NullPointerException

Do not make any checks and force the object's status to the one supplied.
WARNING! Unless you have very good reason, you probably want to use updateStatus(Status).

Parameters:

newStatus - the new (non null) status

Throws:

NullPointerException - if status is null.

addMessage

protected Message addMessage(Message.Level level,
                             String text)

Adds a message to this object, along with its the degree of seriousness

Parameters:

level - the degree of seriouness of the supplied message

text - the message itself

Returns:

the created Message

addDebug

public Message addDebug(String text)

addInfo

public Message addInfo(String text)

addWarning

public Message addWarning(String text)

addError

public Message addError(String text)

isOk

public boolean isOk()

Equivalent to getStatus().equals(Status.OK)

Returns:

true if this object's status is equal to ProgramExecutionResult.Status.OK, false otherwise.

isWarning

public boolean isWarning()

Equivalent to getStatus().equals(Status.WARNING)

Returns:

true if this object's status is equal to ProgramExecutionResult.Status.WARNING, false otherwise.

isError

public boolean isError()

Equivalent to getStatus().equals(Status.ERROR)

Returns:

true if this object's status is equal to ProgramExecutionResult.Status.ERROR, false otherwise.

isTerminated

public boolean isTerminated()

Equivalent to getStatus().equals(Status.TERMINATED)

Returns:

true if this object's status is equal to ProgramExecutionResult.Status.TERMINATED, false otherwise.

id

public String id()

Specified by:

id in interface CommonAttributes

setId

public void setId(String id)

Specified by:

setId in interface CommonAttributes

name

public String name()

Specified by:

name in interface CommonAttributes

mcdaConcept

public String mcdaConcept()

Specified by:

mcdaConcept in interface CommonAttributes

setName

public void setName(String name)

Specified by:

setName in interface CommonAttributes

setMcdaConcept

public void setMcdaConcept(String mcdaConcept)

Specified by:

setMcdaConcept in interface CommonAttributes

setDescription

public void setDescription(Description description)

Specified by:

setDescription in interface HasDescription

getDescription

public Description getDescription()

Specified by:

getDescription in interface HasDescription