org.ow2.proactive.scheduler.common.exception

Class JobCreationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.ow2.proactive.scheduler.common.exception.SchedulerException

org.ow2.proactive.scheduler.common.exception.JobCreationException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JobValidationException

@PublicAPI
public class JobCreationException
extends SchedulerException

Exceptions Generated if a problem occurred while creating a job.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobCreationException(boolean schemaException, Throwable cause) Create a new instance of JobCreationException and tell if it was a schema exception
JobCreationException(String message) Create a new instance of JobCreationException using the given message string
JobCreationException(String tag, String attribute, Exception cause) Create a new instance of JobCreationException using the given tag, attribute and cause.
JobCreationException(String message, Throwable cause) Create a new instance of JobCreationException using the given message string and cause
JobCreationException(Throwable cause) Create a new instance of JobCreationException using the given message string
JobCreationException(XMLTags tag, String attribute, Exception cause) Create a new instance of JobCreationException using the given tag, attribute and cause.

Method Summary

Modifier and Type	Method and Description
XMLAttributes	getAttribute() Get the attribute where the exception has been thrown.
String	getMessage() Return the detail message string of this exception.
String	getShortMessage() Return only the message that is the cause of the exception.
String	getTaskName() Get the taskName where the exception has been thrown.
Stack<XMLTags>	getXMLTagsStack() Return a stack that contains every tags (path) to the element that causes the exception.
boolean	isSchemaException() Get the isSchemaException
void	pushTag(String currentTag) Push a new tag on the stack of tag for this exception
void	pushTag(XMLTags currentTag) Push a new tag on the stack of tag for this exception
void	setTaskName(String taskName) Set the task name on which the problem was found

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JobCreationException

public JobCreationException(String message)

Create a new instance of JobCreationException using the given message string

Parameters:

message - the reason of the exception

JobCreationException

public JobCreationException(Throwable cause)

Create a new instance of JobCreationException using the given message string

Parameters:

cause - the reason of the exception

JobCreationException

public JobCreationException(String message,
                            Throwable cause)

Create a new instance of JobCreationException using the given message string and cause

Parameters:

message - the reason of the exception

cause - the cause of this exception

JobCreationException

public JobCreationException(boolean schemaException,
                            Throwable cause)

Create a new instance of JobCreationException and tell if it was a schema exception

Parameters:

schemaException - true if this exception is due to a Schema exception, false otherwise.

cause - the cause of this exception

JobCreationException

public JobCreationException(String tag,
                            String attribute,
                            Exception cause)

Create a new instance of JobCreationException using the given tag, attribute and cause. Tag and attribute can be null.

Parameters:

tag - the XML tag name where the exception is thrown

attribute - the XML attribute name where the exception is thrown

cause - the cause of this exception

JobCreationException

public JobCreationException(XMLTags tag,
                            String attribute,
                            Exception cause)

Create a new instance of JobCreationException using the given tag, attribute and cause. Tag and attribute can be null.

Parameters:

tag - the XML tag where the exception is thrown

attribute - the XML attribute name where the exception is thrown

cause - the cause of this exception

Method Detail

setTaskName

public void setTaskName(String taskName)

Set the task name on which the problem was found

Parameters:

taskName - the name of the task that generate the problem

pushTag

public void pushTag(String currentTag)

Push a new tag on the stack of tag for this exception

Parameters:

currentTag - the tag name to stack.

pushTag

public void pushTag(XMLTags currentTag)

Push a new tag on the stack of tag for this exception

Parameters:

currentTag - the tag to stack.

getXMLTagsStack

public Stack<XMLTags> getXMLTagsStack()

Return a stack that contains every tags (path) to the element that causes the exception. The first element is always the 'job' tag.

Returns:

a stack that contains every tags (path) to the element that causes the exception.

getMessage

public String getMessage()

Return the detail message string of this exception. This message contains the task name, tag hierarchy, and attribute that generate the exception and then the short message associate to this exception.

Overrides:

getMessage in class Throwable

Returns:

the detail message string of this exception.

getShortMessage

public String getShortMessage()

Return only the message that is the cause of the exception.

Returns:

the message that is the cause of the exception.

isSchemaException

public boolean isSchemaException()

Get the isSchemaException

Returns:

the isSchemaException

getTaskName

public String getTaskName()

Get the taskName where the exception has been thrown.

Returns:

the taskName where the exception has been thrown, null if no taskName was set (ie: exception was thrown in job header.)

getAttribute

public XMLAttributes getAttribute()

Get the attribute where the exception has been thrown.

Returns:

the attribute where the exception has been thrown, null if no attribute was set (ie: exception was thrown in a tag that does not contains an attribute.)