edu.isi.pegasus.common.util

Class FactoryException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

edu.isi.pegasus.common.util.FactoryException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CleanupFactoryException, ClustererFactoryException, CodeGeneratorFactoryException, CondorStyleFactoryException, CredentialHandlerFactoryException, DAXParserFactoryException, GridStartFactoryException, JobAggregatorFactoryException, LogFormatterFactoryException, LogManagerFactoryException, OutputMapperFactoryException, PartitionerFactoryException, PDAXCallbackFactoryException, PPSFactoryException, ReplicaSelectorFactoryException, SiteCatalogXMLParserFactoryException, SiteFactoryException, SiteFactoryException, SiteSelectorFactoryException, SLSFactoryException, TransferImplementationFactoryException, TransferRefinerFactoryException, TransformationFactoryException, WorkFactoryException, XMLProducerFactoryException

public class FactoryException
extends RuntimeException

The base exception class to notify of errors, while instantiating classes via any of the factories. Each factory, should throw an exception that is a subclass of this class.

Author:

Karan Vahi, Jens-S. V??ckler, Gaurang Mehta

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME The default classname that is associated with the exception.
protected String	mClassname The name of the class that was trying to be instantiated when this error occured, or some other signifier like module name.

Constructor Summary

Constructors

Constructor and Description
FactoryException(String msg) Constructs a FactoryException with no detail message.
FactoryException(String msg, String classname) Constructs a FactoryException with the specified detailed message.
FactoryException(String msg, String classname, Throwable cause) Constructs a FactoryException with the specified detailed message and a cause.
FactoryException(String msg, Throwable cause) Constructs a FactoryException with the specified detailed message and a cause.

Method Summary

Methods

Modifier and Type	Method and Description
String	convertException() Converts most of the common instantiation exceptions from the class loader into an error message.
String	convertException(int index) Converts most of the common instantiation exceptions from the class loader into an error message.
static String	convertException(String classname, Throwable e, int index) Converts most of the common instantiation exceptions from the class loader into an error message.
String	getClassname() Returns the name of the class that was trying to be loaded when this error occured, or some other signifier like a module name.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NAME

public static final String DEFAULT_NAME

The default classname that is associated with the exception.

See Also:

Constant Field Values

mClassname

protected String mClassname

The name of the class that was trying to be instantiated when this error occured, or some other signifier like module name.

Constructor Detail

FactoryException

public FactoryException(String msg)

Constructs a FactoryException with no detail message. The associated classname is set to value specified by DEFAULT_NAME.

Parameters:

msg - the detailed message.

See Also:

DEFAULT_NAME

FactoryException

public FactoryException(String msg,
                String classname)

Constructs a FactoryException with the specified detailed message.

Parameters:

msg - is the detailed message.

classname - the name of class that was trying to be instantiated or some other signifier like module name.

FactoryException

public FactoryException(String msg,
                Throwable cause)

Constructs a FactoryException with the specified detailed message and a cause. The associated classname is set to value specified by DEFAULT_NAME.

Parameters:

msg - is the detailed message that is to be logged.

cause - is the cause (which is saved for later retrieval by the Throwable.getCause() method). A null value is permitted, and indicates that the cause is nonexistent or unknown.

See Also:

DEFAULT_NAME

FactoryException

public FactoryException(String msg,
                String classname,
                Throwable cause)

Constructs a FactoryException with the specified detailed message and a cause.

Parameters:

msg - is the detailed message that is to be logged.

classname - the name of class that was trying to be instantiated.

cause - is the cause (which is saved for later retrieval by the Throwable.getCause() method). A null value is permitted, and indicates that the cause is nonexistent or unknown.

Method Detail

convertException

public String convertException()

Converts most of the common instantiation exceptions from the class loader into an error message. Use for getting sensible error messages, of the causes that are associated with a FactoryException. The index in the messages starts from 0.

Returns:

the error message

convertException

public String convertException(int index)

Converts most of the common instantiation exceptions from the class loader into an error message. Use for getting sensible error messages, of the causes that are associated with a FactoryException. The index in the messages starts from 0.

Parameters:

index - the index to start from.

Returns:

the error message.

convertException

public static String convertException(String classname,
                      Throwable e,
                      int index)

Converts most of the common instantiation exceptions from the class loader into an error message. Use for getting sensible error messages, of the causes that are associated with a FactoryException.

Parameters:

classname - the class that was trying to be loaded or some other signifier.

e - the FactoryException that is thrown.

index - the index to start from.

Returns:

the error message.

getClassname

public String getClassname()

Returns the name of the class that was trying to be loaded when this error occured, or some other signifier like a module name.

Returns:

the name of the class.