/*
 * 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 _DECAF_LANG_EXCEPTIONS_INDEXOUTOFBOUNDSEXCEPTION_H_
#define _DECAF_LANG_EXCEPTIONS_INDEXOUTOFBOUNDSEXCEPTION_H_

#include <decaf/lang/Exception.h>

namespace decaf{
namespace lang{
namespace exceptions{

    /*
     * Thrown when an illegal argument was passed into a method.
     */
    class DECAF_API IndexOutOfBoundsException : public Exception
    {
    public:

      /**
       * Default Constructor
       */
      IndexOutOfBoundsException() throw() {}

      /**
       * Conversion Constructor from some other Exception
       * @param An exception that should become this type of Exception
       */
      IndexOutOfBoundsException( const Exception& ex ) throw()
      : Exception()
      {
         *(Exception*)this = ex;
      }

      /**
       * Copy Constructor
       */
      IndexOutOfBoundsException( const IndexOutOfBoundsException& ex ) throw()
      : Exception()
      {
         *(Exception*)this = ex;
      }

      /**
       * Constructor - Initializes the file name and line number where
       * this message occured.  Sets the message to report, using an
       * optional list of arguments to parse into the message
       * @param file name where exception occurs
       * @param line number where the exception occurred.
       * @param message to report
       * @param list of primitives that are formatted into the message
       */
      IndexOutOfBoundsException(const char* file, const int lineNumber,
         const char* msg, ...) throw()
      : Exception()
      {
         va_list vargs ;
         va_start(vargs, msg) ;
         buildMessage(msg, vargs) ;

         // Set the first mark for this exception.
         setMark( file, lineNumber );
      }

      /**
       * Clones this exception.  This is useful for cases where you need
       * to preserve the type of the original exception as well as the message.
       * All subclasses should override.
       */
      virtual IndexOutOfBoundsException* clone() const{
         return new IndexOutOfBoundsException( *this );
      }

      /**
       * Destructor
       */
      virtual ~IndexOutOfBoundsException() throw() {}

    };

}}}

#endif /*_DECAF_LANG_EXCEPTIONS_INDEXOUTOFBOUNDSEXCEPTION_H_*/