binding-cpp/runtime/include/common/EtchException.h

/* $Id$
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License, Version
 * 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __ETCHEXCEPTION_H__
#define __ETCHEXCEPTION_H__

#include "common/EtchString.h"

class EtchException : public EtchObject {
public:

  typedef capu::uint32_t EtchExceptionType;

  enum {
    EXCPTYPE_NONE = 0x0,
    EXCPTYPE_BUILTIN = 0x1,
    EXCPTYPE_USERDEFINED = 0x2
  };


  /**
   * Constructs a EtchException object.
   */
  EtchException();

  /**
   * EtchException
   * @param msg Exception Message
   */
  EtchException(EtchString msg, status_t errcode, EtchExceptionType type);

  /**
   * Constructs a copy of EtchShort.
   */
  EtchException(const EtchException& other);

  /**
   * Destructor
   */
  virtual ~EtchException();

  //overridden
  virtual capu::bool_t equals(const EtchObject * other);

  /**
   *
   * @return Message of Exception
   */
  virtual EtchString getErrorMessage();

  /**
   *
   * @return Error Code of Exception
   */
  status_t getErrorCode();

  /**
   *
   * @return Type of Exception
   */
  EtchExceptionType getExceptionType();

  static const EtchObjectType* TYPE();

protected:
  EtchString mErrorMessage;
  status_t mErrorcode;
  EtchExceptionType mExcptype;
};

#endif /* ETCHEXCEPTION_H */