You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by ta...@apache.org on 2008/05/31 20:55:03 UTC

svn commit: r662063 - in /activemq/activemq-cpp/trunk/src/main/activemq/util: PrimitiveList.h PrimitiveValueNode.h

Author: tabish
Date: Sat May 31 11:55:03 2008
New Revision: 662063

URL: http://svn.apache.org/viewvc?rev=662063&view=rev
Log:
https://issues.apache.org/activemq/browse/AMQCPP-172

Modified:
    activemq/activemq-cpp/trunk/src/main/activemq/util/PrimitiveList.h
    activemq/activemq-cpp/trunk/src/main/activemq/util/PrimitiveValueNode.h

Modified: activemq/activemq-cpp/trunk/src/main/activemq/util/PrimitiveList.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/src/main/activemq/util/PrimitiveList.h?rev=662063&r1=662062&r2=662063&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/src/main/activemq/util/PrimitiveList.h (original)
+++ activemq/activemq-cpp/trunk/src/main/activemq/util/PrimitiveList.h Sat May 31 11:55:03 2008
@@ -35,8 +35,14 @@
     class PrimitiveList : public decaf::util::List<PrimitiveValueNode> {
     public:
 
+        /**
+         * Default Constructor, creates an Empry list.
+         */
         PrimitiveList();
-        virtual ~PrimitiveList() {}
+
+        virtual ~PrimitiveList() {
+            clear();
+        }
 
         /**
          * Copy Constructor
@@ -51,63 +57,243 @@
          */
         std::string toString() const;
 
+        /**
+         * Gets the Boolean value at the specified index.
+         * @param index - index to get value from
+         * @return value contained at the given index
+         * @throw IndexOutOfBoundsException if index is > size()
+         * @throw NoSuchElementException if the type at index is not of the
+         * type that this method is to return.
+         */
         virtual bool getBool( std::size_t index ) const
             throw( decaf::lang::exceptions::IndexOutOfBoundsException,
                    decaf::lang::exceptions::NoSuchElementException );
+
+        /**
+         * Sets the value at the given index to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given, but does not insert a new element if the index is greater
+         * than the size of the list.
+         * @param index - location to set in the list
+         * @param value - the new value to assign to the element at index
+         * @throw IndexOutOfBoundsException if index > size().
+         */
         virtual void setBool( std::size_t index, bool value )
             throw( decaf::lang::exceptions::IndexOutOfBoundsException );
 
+        /**
+         * Gets the Byte value at the specified index.
+         * @param index - index to get value from
+         * @return value contained at the given index
+         * @throw IndexOutOfBoundsException if index is > size()
+         * @throw NoSuchElementException if the type at index is not of the
+         * type that this method is to return.
+         */
         virtual unsigned char getByte( std::size_t index ) const
             throw( decaf::lang::exceptions::IndexOutOfBoundsException,
                    decaf::lang::exceptions::NoSuchElementException );
+
+        /**
+         * Sets the value at the given index to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given, but does not insert a new element if the index is greater
+         * than the size of the list.
+         * @param index - location to set in the list
+         * @param value - the new value to assign to the element at index
+         * @throw IndexOutOfBoundsException if index > size().
+         */
         virtual void setByte( std::size_t index, unsigned char value )
             throw( decaf::lang::exceptions::IndexOutOfBoundsException );
 
+        /**
+         * Gets the Character value at the specified index.
+         * @param index - index to get value from
+         * @return value contained at the given index
+         * @throw IndexOutOfBoundsException if index is > size()
+         * @throw NoSuchElementException if the type at index is not of the
+         * type that this method is to return.
+         */
         virtual char getChar( std::size_t index ) const
             throw( decaf::lang::exceptions::IndexOutOfBoundsException,
                    decaf::lang::exceptions::NoSuchElementException );
+
+        /**
+         * Sets the value at the given index to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given, but does not insert a new element if the index is greater
+         * than the size of the list.
+         * @param index - location to set in the list
+         * @param value - the new value to assign to the element at index
+         * @throw IndexOutOfBoundsException if index > size().
+         */
         virtual void setChar( std::size_t index, char value )
             throw( decaf::lang::exceptions::IndexOutOfBoundsException );
 
+        /**
+         * Gets the Short value at the specified index.
+         * @param index - index to get value from
+         * @return value contained at the given index
+         * @throw IndexOutOfBoundsException if index is > size()
+         * @throw NoSuchElementException if the type at index is not of the
+         * type that this method is to return.
+         */
         virtual short getShort( std::size_t index ) const
             throw( decaf::lang::exceptions::IndexOutOfBoundsException,
                    decaf::lang::exceptions::NoSuchElementException );
+
+        /**
+         * Sets the value at the given index to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given, but does not insert a new element if the index is greater
+         * than the size of the list.
+         * @param index - location to set in the list
+         * @param value - the new value to assign to the element at index
+         * @throw IndexOutOfBoundsException if index > size().
+         */
         virtual void setShort( std::size_t index, short value )
             throw( decaf::lang::exceptions::IndexOutOfBoundsException );
 
+        /**
+         * Gets the Integer value at the specified index.
+         * @param index - index to get value from
+         * @return value contained at the given index
+         * @throw IndexOutOfBoundsException if index is > size()
+         * @throw NoSuchElementException if the type at index is not of the
+         * type that this method is to return.
+         */
         virtual int getInt( std::size_t index ) const
             throw( decaf::lang::exceptions::IndexOutOfBoundsException,
                    decaf::lang::exceptions::NoSuchElementException );
+
+        /**
+         * Sets the value at the given index to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given, but does not insert a new element if the index is greater
+         * than the size of the list.
+         * @param index - location to set in the list
+         * @param value - the new value to assign to the element at index
+         * @throw IndexOutOfBoundsException if index > size().
+         */
         virtual void setInt( std::size_t index, int value )
             throw( decaf::lang::exceptions::IndexOutOfBoundsException );
 
+        /**
+         * Gets the Long value at the specified index.
+         * @param index - index to get value from
+         * @return value contained at the given index
+         * @throw IndexOutOfBoundsException if index is > size()
+         * @throw NoSuchElementException if the type at index is not of the
+         * type that this method is to return.
+         */
         virtual long long getLong( std::size_t index ) const
             throw( decaf::lang::exceptions::IndexOutOfBoundsException,
                    decaf::lang::exceptions::NoSuchElementException );
+
+        /**
+         * Sets the value at the given index to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given, but does not insert a new element if the index is greater
+         * than the size of the list.
+         * @param index - location to set in the list
+         * @param value - the new value to assign to the element at index
+         * @throw IndexOutOfBoundsException if index > size().
+         */
         virtual void setLong( std::size_t index, long long value )
             throw( decaf::lang::exceptions::IndexOutOfBoundsException );
 
-        virtual double getDouble( std::size_t index ) const
+        /**
+         * Gets the Float value at the specified index.
+         * @param index - index to get value from
+         * @return value contained at the given index
+         * @throw IndexOutOfBoundsException if index is > size()
+         * @throw NoSuchElementException if the type at index is not of the
+         * type that this method is to return.
+         */
+        virtual float getFloat( std::size_t index ) const
             throw( decaf::lang::exceptions::IndexOutOfBoundsException,
                    decaf::lang::exceptions::NoSuchElementException );
-        virtual void setDouble( std::size_t index, double value )
+
+        /**
+         * Sets the value at the given index to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given, but does not insert a new element if the index is greater
+         * than the size of the list.
+         * @param index - location to set in the list
+         * @param value - the new value to assign to the element at index
+         * @throw IndexOutOfBoundsException if index > size().
+         */
+        virtual void setFloat( std::size_t index, float value )
             throw( decaf::lang::exceptions::IndexOutOfBoundsException );
 
-        virtual float getFloat( std::size_t index ) const
+        /**
+         * Gets the Double value at the specified index.
+         * @param index - index to get value from
+         * @return value contained at the given index
+         * @throw IndexOutOfBoundsException if index is > size()
+         * @throw NoSuchElementException if the type at index is not of the
+         * type that this method is to return.
+         */
+        virtual double getDouble( std::size_t index ) const
             throw( decaf::lang::exceptions::IndexOutOfBoundsException,
                    decaf::lang::exceptions::NoSuchElementException );
-        virtual void setFloat( std::size_t index, float value )
+
+        /**
+         * Sets the value at the given index to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given, but does not insert a new element if the index is greater
+         * than the size of the list.
+         * @param index - location to set in the list
+         * @param value - the new value to assign to the element at index
+         * @throw IndexOutOfBoundsException if index > size().
+         */
+        virtual void setDouble( std::size_t index, double value )
             throw( decaf::lang::exceptions::IndexOutOfBoundsException );
 
+        /**
+         * Gets the String value at the specified index.
+         * @param index - index to get value from
+         * @return value contained at the given index
+         * @throw IndexOutOfBoundsException if index is > size()
+         * @throw NoSuchElementException if the type at index is not of the
+         * type that this method is to return.
+         */
         virtual std::string getString( std::size_t index ) const
             throw( decaf::lang::exceptions::IndexOutOfBoundsException,
                    decaf::lang::exceptions::NoSuchElementException );
+
+        /**
+         * Sets the value at the given index to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given, but does not insert a new element if the index is greater
+         * than the size of the list.
+         * @param index - location to set in the list
+         * @param value - the new value to assign to the element at index
+         * @throw IndexOutOfBoundsException if index > size().
+         */
         virtual void setString( std::size_t index, const std::string& value )
             throw( decaf::lang::exceptions::IndexOutOfBoundsException );
 
+        /**
+         * Gets the Byte Array value at the specified index.
+         * @param index - index to get value from
+         * @return value contained at the given index
+         * @throw IndexOutOfBoundsException if index is > size()
+         * @throw NoSuchElementException if the type at index is not of the
+         * type that this method is to return.
+         */
         virtual std::vector<unsigned char> getByteArray( std::size_t index ) const
             throw( decaf::lang::exceptions::IndexOutOfBoundsException,
                    decaf::lang::exceptions::NoSuchElementException );
+
+        /**
+         * Sets the value at the given index to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given, but does not insert a new element if the index is greater
+         * than the size of the list.
+         * @param index - location to set in the list
+         * @param value - the new value to assign to the element at index
+         * @throw IndexOutOfBoundsException if index > size().
+         */
         virtual void setByteArray( std::size_t index, const std::vector<unsigned char>& value )
             throw( decaf::lang::exceptions::IndexOutOfBoundsException );
 

Modified: activemq/activemq-cpp/trunk/src/main/activemq/util/PrimitiveValueNode.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/src/main/activemq/util/PrimitiveValueNode.h?rev=662063&r1=662062&r2=662063&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/src/main/activemq/util/PrimitiveValueNode.h (original)
+++ activemq/activemq-cpp/trunk/src/main/activemq/util/PrimitiveValueNode.h Sat May 31 11:55:03 2008
@@ -191,43 +191,173 @@
          */
         void clear();
 
+        /**
+         * Sets the value of this value node to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given.
+         * @param value - the new value to assign to the element at index
+         */
         void setBool( bool lvalue );
+
+        /**
+         * Gets the Boolean value of this Node.
+         * @return value contained at the given index
+         * @throw NoSuchElementException this node cannot be returned as the
+         * requested type.
+         */
         bool getBool() const
             throw( decaf::lang::exceptions::NoSuchElementException );
 
+        /**
+         * Sets the value of this value node to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given.
+         * @param value - the new value to assign to the element at index
+         */
         void setByte( unsigned char lvalue );
+
+        /**
+         * Gets the Byte value of this Node.
+         * @return value contained at the given index
+         * @throw NoSuchElementException this node cannot be returned as the
+         * requested type.
+         */
         unsigned char getByte() const
             throw( decaf::lang::exceptions::NoSuchElementException );
 
+        /**
+         * Sets the value of this value node to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given.
+         * @param value - the new value to assign to the element at index
+         */
         void setChar( char lvalue );
+
+        /**
+         * Gets the Character value of this Node.
+         * @return value contained at the given index
+         * @throw NoSuchElementException this node cannot be returned as the
+         * requested type.
+         */
         char getChar() const
             throw( decaf::lang::exceptions::NoSuchElementException );
 
+        /**
+         * Sets the value of this value node to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given.
+         * @param value - the new value to assign to the element at index
+         */
         void setShort( short lvalue );
+
+        /**
+         * Gets the Short value of this Node.
+         * @return value contained at the given index
+         * @throw NoSuchElementException this node cannot be returned as the
+         * requested type.
+         */
         short getShort() const
             throw( decaf::lang::exceptions::NoSuchElementException );
 
+        /**
+         * Sets the value of this value node to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given.
+         * @param value - the new value to assign to the element at index
+         */
         void setInt( int lvalue );
+
+        /**
+         * Gets the Integer value of this Node.
+         * @return value contained at the given index
+         * @throw NoSuchElementException this node cannot be returned as the
+         * requested type.
+         */
         int getInt() const
             throw( decaf::lang::exceptions::NoSuchElementException );
 
+        /**
+         * Sets the value of this value node to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given.
+         * @param value - the new value to assign to the element at index
+         */
         void setLong( long long lvalue );
+
+        /**
+         * Gets the Long value of this Node.
+         * @return value contained at the given index
+         * @throw NoSuchElementException this node cannot be returned as the
+         * requested type.
+         */
         long long getLong() const
             throw( decaf::lang::exceptions::NoSuchElementException );
 
-        void setDouble( double lvalue );
-        double getDouble() const
-            throw(decaf::lang::exceptions::NoSuchElementException );
-
+        /**
+         * Sets the value of this value node to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given.
+         * @param value - the new value to assign to the element at index
+         */
         void setFloat( float lvalue );
+
+        /**
+         * Gets the Float value of this Node.
+         * @return value contained at the given index
+         * @throw NoSuchElementException this node cannot be returned as the
+         * requested type.
+         */
         float getFloat() const
             throw( decaf::lang::exceptions::NoSuchElementException );
 
+        /**
+         * Sets the value of this value node to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given.
+         * @param value - the new value to assign to the element at index
+         */
+        void setDouble( double lvalue );
+
+        /**
+         * Gets the Double value of this Node.
+         * @return value contained at the given index
+         * @throw NoSuchElementException this node cannot be returned as the
+         * requested type.
+         */
+        double getDouble() const
+            throw(decaf::lang::exceptions::NoSuchElementException );
+
+        /**
+         * Sets the value of this value node to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given.
+         * @param value - the new value to assign to the element at index
+         */
         void setString( const std::string& lvalue );
+
+        /**
+         * Gets the String value of this Node.
+         * @return value contained at the given index
+         * @throw NoSuchElementException this node cannot be returned as the
+         * requested type.
+         */
         std::string getString() const
             throw( decaf::lang::exceptions::NoSuchElementException );
 
+        /**
+         * Sets the value of this value node to the new value specified,
+         * this method overwrites any data that was previously at the index
+         * given.
+         * @param value - the new value to assign to the element at index
+         */
         void setByteArray( const std::vector<unsigned char>& lvalue );
+
+        /**
+         * Gets the Byte Array value of this Node.
+         * @return value contained at the given index
+         * @throw NoSuchElementException this node cannot be returned as the
+         * requested type.
+         */
         std::vector<unsigned char> getByteArray() const
             throw( decaf::lang::exceptions::NoSuchElementException );