alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx Class Reference

Inheritance diagram for alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx:
Inheritance graph
[legend]
Collaboration diagram for alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 AcsJIllegalStateEventEx ()
 AcsJIllegalStateEventEx (String message)
 AcsJIllegalStateEventEx (String message, Throwable cause)
 AcsJIllegalStateEventEx (Throwable cause)
 AcsJIllegalStateEventEx (ErrorTrace etCause)
 AcsJIllegalStateEventEx (String message, ErrorTrace etCause)
String getShortDescription ()
UserException toCorbaException ()
IllegalStateEventEx toIllegalStateEventEx ()
void setEvent (String value)
String getEvent ()
void setState (String value)
String getState ()

Static Public Member Functions

static AcsJIllegalStateEventEx fromIllegalStateEventEx (IllegalStateEventEx corbaEx)

Protected Member Functions

final int getErrorCode ()

Detailed Description

Java native style exception class representing the error type alma.ACSErr.ACSErrType.ACSErrTypeCommon, error code IllegalStateEvent.value.

See also:
AcsJACSErrTypeCommonEx
Author:
ACS Error System Code Generator created Sep 25, 2003 4:18:09 PM

Constructor & Destructor Documentation

alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::AcsJIllegalStateEventEx (  )  [inline]

Referenced by fromIllegalStateEventEx().

alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::AcsJIllegalStateEventEx ( String  message  )  [inline]
Deprecated:
The data in message should be given as parameters instead!
alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::AcsJIllegalStateEventEx ( String  message,
Throwable  cause 
) [inline]
Deprecated:
The data in message should be given as parameters instead!
alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::AcsJIllegalStateEventEx ( Throwable  cause  )  [inline]
alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::AcsJIllegalStateEventEx ( ErrorTrace  etCause  )  [inline]
alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::AcsJIllegalStateEventEx ( String  message,
ErrorTrace  etCause 
) [inline]
Deprecated:
The data in message should be given as parameters instead!

Member Function Documentation

static AcsJIllegalStateEventEx alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::fromIllegalStateEventEx ( IllegalStateEventEx  corbaEx  )  [inline, static]

Converts a CORBA IllegalStateEvent to an instance of this class.

Note that unlike the constructor AcsJErrTest0Ex(ErrorTrace), this static conversion method does not wrap the existing chain of exceptions with a new exception. It simply converts all exceptions found in the ErrorTrace of corbaEx to the corresponding Java exceptions, knowing that the top level exception is of type IllegalStateEvent and can always be converted to AcsJIllegalStateEventEx.

Here's an example of how to use this method in a Java program that makes a call so some other component etc.: 

 private void methodThatMakesARemoteCall() throws AcsJIllegalStateEventEx
 {
   try
   {
     // this fakes the remote call to a method
     // which can throw an IllegalStateEventEx...
     throw new IllegalStateEventEx();
   }
   catch (IllegalStateEventEx corbaEx)
   {
     throw AcsJIllegalStateEventEx.fromIllegalStateEventEx(corbaEx);
   }
 }
Parameters:
corbaEx the CORBA equivalent of this class; will be converted
Returns:
the newly created instance, with data fields and caused-by exceptions converted from corbaEx.

References AcsJIllegalStateEventEx(), and alma::ACSErrTypeCommon::IllegalStateEventEx::errorTrace.

final int alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::getErrorCode (  )  [inline, protected, virtual]

Returns the error code, which is fixed to 14, given by IllegalStateEvent.value.

See also:
alma.acs.exceptions.AcsJException::getErrorCode()

Implements alma::acs::exceptions::AcsJException.

String alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::getEvent (  )  [inline]

References alma::acs::exceptions::AcsJException::getProperty().

Referenced by alma::ACS::MasterComponentImpl::MasterComponentImplBase::doTransition(), alma::ACS::MasterComponentImpl::statemachine::StateMachineTest::testActionException(), and alma::ACS::MasterComponentImpl::statemachine::StateMachineTest::testIllegalEvent().

String alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::getShortDescription (  )  [inline]

Returns the short description of the error

Reimplemented from alma::acs::exceptions::AcsJException.

String alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::getState (  )  [inline]

References alma::acs::exceptions::AcsJException::getProperty().

Referenced by alma::ACS::MasterComponentImpl::MasterComponentImplBase::doTransition(), alma::ACS::MasterComponentImpl::statemachine::StateMachineTest::testActionException(), and alma::ACS::MasterComponentImpl::statemachine::StateMachineTest::testIllegalEvent().

void alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::setEvent ( String  value  )  [inline]

References alma::acs::exceptions::AcsJException::setProperty().

Referenced by alma::ACS::MasterComponentImpl::MasterComponentImplBase::doTransition(), and alma::ACS::MasterComponentImpl::statemachine::AlmaSubsystemContext::illegalEvent().

void alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::setState ( String  value  )  [inline]

References alma::acs::exceptions::AcsJException::setProperty().

Referenced by alma::ACS::MasterComponentImpl::statemachine::AlmaSubsystemContext::illegalEvent().

UserException alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::toCorbaException (  )  [inline, virtual]
See also:
alma.acs.exceptions.AcsJException::toCorbaException()

Implements alma::acs::exceptions::AcsJException.

References toIllegalStateEventEx().

IllegalStateEventEx alma::ACSErrTypeCommon::wrappers::AcsJIllegalStateEventEx::toIllegalStateEventEx (  )  [inline]

Creates an IllegalStateEvent that represents this exception with all its caused-by child exceptions.

Typically to be called from a top-level catch block that must convert any of the Java exceptions used internally by the Java program to an IDL type exception that can be thrown on over CORBA.

Returns:
the type-safe subclass of org.omg.CORBA.UserException with an embedded ErrorTrace.
See also:
toCorbaException

References alma::acs::exceptions::AcsJException::getErrorTrace().

Referenced by alma::ACS::MasterComponentImpl::MasterComponentImplBase::doTransition(), and toCorbaException().

The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.2