com.arsdigita.util.parameter
Class ParameterException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byjava.lang.RuntimeException
              extended bycom.arsdigita.util.parameter.ParameterException
All Implemented Interfaces:
Serializable

public final class ParameterException
extends RuntimeException

Subject to change. An exception to indicate invalid parameter states. This exception should only be used when the client code of a parameter opts in to using exceptions rather than handling parameter errors itself. See ErrorList.check().

Version:
$Id: //core-platform/dev/src/com/arsdigita/util/parameter/ParameterException.java#6 $
Author:
Justin Ross <jross@redhat.com>
See Also:
ErrorList, Serialized Form

Field Summary
static String versionId
           
 
Constructor Summary
ParameterException(String message, ErrorList errors)
          Constructs a new parameter exception with the content message.
 
Method Summary
 ErrorList getErrors()
          Gets the set of errors associated with the exception.
 
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

versionId

public static final String versionId
See Also:
Constant Field Values
Constructor Detail

ParameterException

public ParameterException(String message,
                          ErrorList errors)
Constructs a new parameter exception with the content message.

Parameters:
message - A String describing what's wrong; it cannot be null
errors - The ErrorList containing the errors that prompted this exception; it cannot be null
Method Detail

getErrors

public final ErrorList getErrors()
Gets the set of errors associated with the exception.

Returns:
The ErrorList of errors; it cannot be null


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC