uk.ac.sheffield.vtts.model

Class Failure

java.lang.Object

uk.ac.sheffield.vtts.model.Element

uk.ac.sheffield.vtts.model.Named

uk.ac.sheffield.vtts.model.Expression

uk.ac.sheffield.vtts.model.Parameter

uk.ac.sheffield.vtts.model.Failure

public class Failure
extends Parameter

Failure is an exception or error parameter associated with an operation. When it is simulated, an Operation may bind one or more of its declared Failures to indicate that a modelled Exception has occurred, rather than return the usual Outputs. Failure and Output parameters are disjoint and will not both be returned.

Version:

Broker@Cloud 1.0

Author:

Anthony J H Simons

Field Summary

Fields inherited from class uk.ac.sheffield.vtts.model.Parameter

bound, content, value

Fields inherited from class uk.ac.sheffield.vtts.model.Expression

factory, type

Fields inherited from class uk.ac.sheffield.vtts.model.Named

name

Constructor Summary

Constructors

Constructor and Description
Failure() Creates a default failure parameter.
Failure(java.lang.String name, java.lang.String type) Creates an output parameter with the given name and type.

Method Summary

Methods

Modifier and Type	Method and Description
Failure	setType(java.lang.String type) Sets the type of this Failure.

Methods inherited from class uk.ac.sheffield.vtts.model.Parameter

assign, evaluate, getBound, getContent, isAssignable, isBound, rebind, rebind, resolve, setBound, setContent, snapshot, toString, unbind

Methods inherited from class uk.ac.sheffield.vtts.model.Expression

equals, getName, getType, hashCode, isBottom, isOrdered

Methods inherited from class uk.ac.sheffield.vtts.model.Named

setName, setName

Methods inherited from class uk.ac.sheffield.vtts.model.Element

safeEquals, safeHashCode, semanticError

Methods inherited from class java.lang.Object

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

Constructor Detail

Failure

public Failure()

Creates a default failure parameter.

Failure

public Failure(java.lang.String name,
       java.lang.String type)

Creates an output parameter with the given name and type. The most common type is String, representing an error message type.

Parameters:

name - the name of this Failure.

type - the type of this Failure.

Method Detail

setType

public Failure setType(java.lang.String type)

Sets the type of this Failure. The most common type to set is String, representing an error message type.

Overrides:

setType in class Expression

Parameters:

type - the type to set.

Returns:

this Parameter.