*
* @since 2.0
*
- * The %ByteBuffer class provides a means of encapsulating a sequence of bytes in memory. It defines
+ * The %ByteBuffer class provides a means of encapsulating a sequence of bytes in the memory. It defines
* methods to read and write all primitive built-in types (except @c bool), to and from a sequence of
* bytes. These methods read the size of primitive type bytes from a @c byte sequence and
* convert it to the actual primitive type.
public:
/**
- * The object is not fully constructed after this constructor is called.
+ * The object is not fully constructed after this constructor is called. @n
* For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.0
*
- * @remarks After creating an instance of the %ByteBuffer class, one of the Construct() methods must be called explicitly to initialize this instance.
- * @see Construct()
+ * @remarks After creating an instance of %ByteBuffer, one of the Construct() methods must be called explicitly to initialize this instance.
*/
ByteBuffer(void);
virtual ~ByteBuffer(void);
/**
- * Initializes this instance of %ByteBuffer which is a view of the specified buffer. @n
- * This is the copy constructor for the %ByteBuffer class.
+ * Initializes this instance of %ByteBuffer which is a view of the specified @c buffer. @n
+ * This is the copy constructor of the %ByteBuffer class.
*
* @since 2.0
*
- * @param[in] buffer The %ByteBuffer instance used to initialize new object
+ * @param[in] buffer The %ByteBuffer instance used to initialize the new object
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the source buffer is not constructed.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The source buffer has not been constructed.
* @see ByteBuffer()
*/
result Construct(const ByteBuffer& buffer);
* @return An error code
* @param[in] capacity The number of elements
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c capacity is negative.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c capacity is negative.
* @see ByteBuffer()
*/
result Construct(int capacity);
* @since 2.0
*
* @return An error code
- * @param[in] pBuffer The buffer which is shared
+ * @param[in] pBuffer The shared buffer
* @param[in] index The starting index of the buffer from where the first @c byte value is read
- * @param[in] length The number of bytes to read from the given buffer @n This is a limit of this instance.
+ * @param[in] length The number of bytes to read from the given buffer @n
+ * This is the limit of this instance.
* @param[in] capacity The capacity of this instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c pBuffer is @c null.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the @c length.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c pBuffer is @c null.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than or equal to the specfied @c capacity.
*/
result Construct(const byte* pBuffer, int index, int length, int capacity);
/**
- * Gets the reference to the byte value at the specified index.
+ * Gets a reference to the @c byte value at the specified @c index.
*
- * @since 2.0
+ * @since 2.0
*
* @return A reference to the @c byte value
* @param[in] index The index of the @c byte value in the calling %ByteBuffer instance @n
byte& operator [](int index);
/**
- * Gets the byte value at the specified index of const object.
+ * Gets the @c byte value at the specified @c index of the constant object.
*
* @since 2.0
*
- * @return A value to the @c byte value
+ * @return The @c byte value at the specified @c index
* @param[in] index The index of the @c byte value in the calling %ByteBuffer instance @n
* It must be less than the limit.
*/
byte operator [](int index) const;
/**
- * Compares the two %ByteBuffer instances.
+ * Compares two %ByteBuffer instances.
*
* @since 2.0
*
* @return @c true if the input buffer is equal to the calling %ByteBuffer instance, @n
* else @c false
* @param[in] buffer The %ByteBuffer instance to compare with the current instance
- * @remarks This method returns @c true only if the two buffers have the same number of
- * remaining elements, and the two sequences of remaining elements are equal
- * (considered independently, irrespective of their starting positions).
+ * @remarks This method returns @c true if the two buffers have the same number of
+ * remaining elements, and the sequences of the remaining elements are equal
+ * (considered independently, irrespective of their starting positions).
* @see Equals()
*/
bool operator ==(const ByteBuffer& buffer) const;
/**
- * Checks whether the current instance and the specified instance of %ByteBuffer are not equal.
+ * Checks whether the current instance and the specfied %ByteBuffer instance are not equal.
*
* @since 2.0
*
- * @return @c true if the two objects are not the same, @n
+ * @return @c true if the current instance and the specified %ByteBuffer instance are not equal, @n
* else @c false
- * @param[in] buffer The buffer to compare with the current instance
- * @remarks This method returns @c false only if the two buffers being compared have the same
- * number of remaining elements, and the two sequences of remaining elements are equal
- * (considered independently, irrespective of their starting positions).
+ * @param[in] buffer The %ByteBuffer instance to compare with the current instance
+ * @remarks This method returns @c false if the two buffers have the same
+ * number of remaining elements, and the sequences of the remaining elements are equal
+ * (considered independently, irrespective of their starting positions).
* @see Equals()
*/
bool operator !=(const ByteBuffer& buffer) const;
*
* @since 2.0
*
- * @return DoubleBuffer A pointer to the current position of the calling object
- * @remarks The content of the view buffer starts at the current position of the calling buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of this buffer divided by the size of @c double.
- * Any change to the byte buffer content is visible in the @c double buffer view, and vice versa.
+ * @return DoubleBuffer A pointer to the current position of the calling object
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c double value.
+ * - Any change to the byte buffer content is visible in the @c double buffer view, and vice versa.
*/
DoubleBuffer* AsDoubleBufferN(void) const;
*
* @since 2.0
*
- * @return FloatBuffer A pointer to the current position of the calling buffer
- * @remarks The content of the view buffer starts at the current position of the calling buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of the calling buffer divided by the size of @c float.
- * Any change to the byte buffer content is visible in the @c float buffer view, and vice versa.
+ * @return FloatBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c float value.
+ * - Any change to the byte buffer content is visible in the @c float buffer view, and vice versa.
*/
FloatBuffer* AsFloatBufferN(void) const;
*
* @since 2.0
*
- * @return IntBuffer A pointer to the current position of the calling buffer
- * @remarks The content of the view buffer starts at the current position of the calling buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of calling buffer divided by the size of @c int.
- * Any change to the byte buffer content is visible in the Int buffer view, and vice versa.
+ * @return IntBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c int value.
+ * - Any change to the byte buffer content is visible in the @c int buffer view, and vice versa.
*/
IntBuffer* AsIntBufferN(void) const;
*
* @since 2.0
*
- * @return LongBuffer A pointer to the current position of the calling buffer
- * @remarks The content of the view buffer starts at the current position of this buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of calling buffer divided by the size of @c long.
- * Any change to the byte buffer content is visible in the @c long buffer view, and vice versa.
+ * @return LongBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c long value.
+ * - Any change to the byte buffer content is visible in the @c long buffer view, and vice versa.
*/
LongBuffer* AsLongBufferN(void) const;
*
* @since 2.0
*
- * @return LongLongBuffer A pointer to the current position of the calling buffer
- * @remarks The content of the view buffer starts at the current position of this buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of calling buffer divided by the size of @c long.
- * Any change to the byte buffer content is visible in the @c long @c long buffer view, and vice versa.
+ * @return LongLongBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c long @c long value.
+ * - Any change to the byte buffer content is visible in the @c long @c long buffer view, and vice versa.
*/
LongLongBuffer* AsLongLongBufferN(void) const;
* @if OSPDEPREC
* Creates a new @c mchar buffer view of the underlying content of the byte buffer.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the AsWcharBufferN() method.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
+ * Instead of using this method, use the AsWcharBufferN() method.
* @since 2.0
*
- * @return McharBuffer A pointer to the current position of the calling buffer
- * @remarks The content of the view buffer starts at the current position of this buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of the calling buffer divided by the size of @c long.
- * Any change to the byte buffer content is visible in the @c mchar buffer view, and vice versa.
+ * @return McharBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c mchar value.
+ * - Any change to the byte buffer content is visible in the @c mchar buffer view, and vice versa.
* @endif
*/
McharBuffer* AsMcharBufferN(void) const;
/**
- * Creates a new wchar Buffer view of the underlying content of the byte buffer.
+ * Creates a new @c wchar buffer view of the underlying content of the byte buffer.
*
* @since 2.0
*
- * @return WcharBuffer pointer to the current position of the calling buffer
- * @remarks The content of the view buffer start at the current position of this buffer. @n
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of the calling buffer divided by the size of @c long. @n
- * Any changes to the calling buffer's content (that is, the content of %ByteBuffer instance) @n
- * are visible in the WcharBuffer view, and vice versa.
+ * @return WcharBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer start at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c wchar value.
+ * - Any change to the byte buffer content is visible in the @c wchar buffer view, and vice versa.
*/
WcharBuffer* AsWcharBufferN(void) const;
*
* @since 2.0
*
- * @return ShortBuffer pointer to the current position of the calling buffer
- * @remarks The content of the view buffer starts at the current position of this buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of calling buffer divided by the size of @c long.
- * Any change to the byte buffer content is visible in the @c short buffer view, and vice versa.
+ * @return ShortBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c short value.
+ * - Any change to the byte buffer content is visible in the @c short buffer view, and vice versa.
*/
ShortBuffer* AsShortBufferN(void) const;
/**
* Copies the remaining bytes of the input %ByteBuffer instance into the calling %ByteBuffer object. @n
- * It returns E_OVERFLOW if the remaining bytes in the current instance are less
+ * It returns @c E_OVERFLOW if the remaining bytes in the current instance are less
* than the remaining bytes in the input instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] buffer The source buffer from which bytes are read @n
- * It must not be the calling object.
+ * @param[in] buffer The source buffer from which bytes are read @n
+ * It must not be the calling object.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid. @n
- * The source buffer is same as destination buffer,
- * that is, the current instance of the buffer.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n
- * The number of remaining bytes of the current buffer is smaller than
- * the number of remaining bytes of the input buffer.
- * @remarks After the copy operation, the current (destination) buffer's position and the given
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The source buffer is same as the destination buffer,
+ * that is, the current instance of the buffer.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The number of remaining bytes in the current buffer is smaller than
+ * the number of remaining bytes in the input buffer.
+ * @remarks
+ * - After the copy operation, the current (destination) buffer's position and the given
* (source) buffer's positions are incremented by the number of bytes copied (the number of
- * remaining bytes of the given buffer). @n
- * If the remaining part of the current instance is greater than or equal to the remaining part of the input instance,
- * the effect of this method and the ReadFrom(%ByteBuffer) method is the same. But when the remaining part of the
- * current instance is less, the ReadFrom() method copies the number of remaining elements of the current
- * instance while this method returns E_OVERFLOW and does not copy.
- * @see ReadFrom()
+ * remaining bytes in the given buffer).
+ * - If the remaining part of the current instance is greater than or equal to the remaining part of the input instance,
+ * the effect of this method and the ReadFrom() method is the same. @n
+ * If the remaining part of the current instance is less, the %ReadFrom() method
+ * copies the number of remaining elements of the current instance while this method returns @c E_OVERFLOW and does not copy.
*
* The following example demonstrates how to use the %CopyFrom() method.
*
* @since 2.0
*
* @return An error code
- * @param[out] pArray A pointer to the destination array into which the bytes are written
- * @param[in] index The starting index in the array of the first byte to write
- * @param[in] length The number of bytes to write to the given array
+ * @param[out] pArray A pointer to the destination array into which the bytes are written
+ * @param[in] index The starting index of the array where the first byte is written
+ * @param[in] length The number of bytes to write into the given array
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c pArray is @c null.
- * @exception E_OUT_OF_RANGE A specified input parameter is invalid. @n
- * The @c index or @c length is less than @c 0.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than @c length.
- * @remarks This method copies @c length bytes from the current instance of %ByteBuffer to the given array,
- * starting at the current position and at the given index in the array.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c pArray is @c null.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c index or the specified @c length is less than @c 0.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the specified @c length.
+ * @remarks This method copies @c length bytes from the current instance of %ByteBuffer into the given array,
+ * starting from the current position and the given index in the array. @n
* After the copy operation, the position is incremented by @c length bytes.
* @see SetArray()
*/
/**
* Gets the @c byte value from the buffer at the current position, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c byte value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the current position is not smaller than the limit.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The current position is not smaller than the limit.
* @see SetByte()
*/
result GetByte(byte& value);
/**
* Gets the @c byte value at the given index. @n
- * Provides a way for absolute indexing and reading.
+ * It provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the byte is read
- * @param[out] value The @c byte value at the given @c index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the byte is read
+ * @param[out] value The @c byte value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is not smaller than the limit or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is not smaller than the limit.
+ * - The specified @c index is less than @c 0.
* @see SetByte()
*/
result GetByte(int index, byte& value) const;
/**
- * Gets the size of @c double number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c double number of bytes from the buffer at the current position, converts
* it to the corresponding @c double equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c double value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c double.
- * @remarks This method reads the next size of @c double number of bytes at the current position,
- * composing it into a @c double value, and then increments the position by the size of @c double.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes in this buffer are smaller than the size of the @c double value.
+ * @remarks This method reads the next size of the @c double number of bytes at the current position,
+ * converts it into a @c double value, and then increments the position by the size of the @c double value.
* @see SetDouble()
*/
result GetDouble(double& value);
/**
- * Gets the size of @c double number of bytes at the given index and converts it to the equivalent @c double value. @n
- * Provides a way for absolute indexing and reading.
+ * Gets the size of the @c double number of bytes at the given index and converts it to the equivalent @c double value. @n
+ * It provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c double value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c double value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c double or less than @c 0.
- * @remarks This method reads size of @c double number of bytes at the given index,
- * composing them into a @c double value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c double value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c double number of bytes at the given @c index
+ * and converts it into a @c double value.
* @see SetDouble()
*/
result GetDouble(int index, double& value) const;
/**
- * Gets the size of @c float number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c float number of bytes from the buffer at the current position, converts
* it to the corresponding @c float equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c float value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c float.
- * @remarks This method reads the next size of @c float number of bytes at the current position,
- * composing it into a @c float value, and then increments the position by the size of @c float.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c float value.
+ * @remarks This method reads the next size of the @c float number of bytes at the current position,
+ * converts it into a @c float value, and then increments the position by the size of the @c float value.
* @see SetFloat()
*/
result GetFloat(float& value);
/**
- * Gets the size of @c float number of bytes at the given index and converts it to equivalent @c float value. @n
- * Provides a way for absolute indexing and reading.
+ * Gets the size of the @c float number of bytes at the given index and converts it to an equivalent @c float value. @n
+ * It provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c float value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c float value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c float or less than @c 0.
- * @remarks This method reads the size of @c float number of bytes at the given index,
- * composing it into a @c float value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c float value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c float number of bytes at the given @c index
+ * and converts it into a @c float value.
* @see SetFloat()
*/
result GetFloat(int index, float& value) const;
/**
- * Gets the size of @c int number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c int number of bytes from the buffer at the current position, converts
* it to the corresponding @c int equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c int value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c int.
- * @remarks This method reads the next size of @c int number of bytes at the current position,
- * composing them into an @c int value, and then increments the position by the size of @c int.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c int value.
+ * @remarks This method reads the next size of the @c int number of bytes at the current position,
+ * converts them into an @c int value, and then increments the position by the size of the @c int value.
* @see SetInt()
*/
result GetInt(int& value);
/**
- * Gets the size of @c int number of bytes at the given index and converts it to the equivalent @c int value. @n
- * Provides a way for absolute indexing and reading.
+ * Gets the size of the @c int number of bytes at the given @c index and converts it to the equivalent @c int value. @n
+ * It provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c int value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c int value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c int or negative.
- * @remarks This method reads the size of @c int number of bytes at the given index,
- * composing it into an @c int value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c int.
+ * - The specified @c index is negative.
+ * @remarks This method reads the size of the @c int number of bytes at the given @c index
+ * and converts it into an @c int value.
* @see SetInt()
*/
result GetInt(int index, int& value) const;
/**
- * Gets the size of @c long number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c long number of bytes from the buffer at the current position, converts
* it to the corresponding @c long equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c long value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c long.
- * @remarks This method reads the next size of @c long number of bytes at the current position,
- * composing it into a @c long value, and then increments the position by the size of @c long.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c long value.
+ * @remarks This method reads the next size of the @c long number of bytes at the current position,
+ * converts it into a @c long value, and then increments the position by the size of the @c long value.
* @see SetLong()
*/
result GetLong(long& value);
/**
- * Gets the size of @c long number of bytes at the given index and converts it to equivalent @c long value. @n
- * Provides a way for absolute indexing and reading.
+ * Gets the size of the @c long number of bytes at the given @c index and converts it to the equivalent @c long value. @n
+ * It provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c long value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c long value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c long or less than @c 0.
- * @remarks This method reads the size of @c long number of bytes at the given index,
- * composing it into a @c long value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c long value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c long number of bytes at the given @c index
+ * and converts it into a @c long value.
* @see SetLong()
*/
result GetLong(int index, long& value) const;
/**
- * Gets the size of @c long @c long number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c long @c long number of bytes from the buffer at the current position, converts
* it to the corresponding @c long @c long equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c long @c long value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c long @c long.
- * @remarks This method reads the next size of @c long @c long number of bytes at the current position,
- * composing it into a @c long @c long value, and then increments the position by the size of @c long @c long.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c long @c long value.
+ * @remarks This method reads the next size of the @c long @c long number of bytes at the current position,
+ * converts it into a @c long @c long value, and then increments the position by the size of the @c long @c long value.
* @see SetLongLong()
*/
result GetLongLong(long long& value);
/**
- * Gets the size of @c long @c long number of bytes at the given index and converts it to the equivalent @c long @c long value. @n
- * Provides a way for absolute indexing and reading.
+ * Gets the size of the @c long @c long number of bytes at the given @c index and converts it to the equivalent @c long @c long value. @n
+ * It provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c long @c long value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c long @c long value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c long @c long or less than @c 0.
- * @remarks This method reads the size of @c long @c long number of bytes at the given index,
- * composing it into a @c long @c long value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c long @c long value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c long @c long number of bytes at the given @c index
+ * and converts it into a @c long @c long value.
* @see SetLongLong()
*/
result GetLongLong(int index, long long& value) const;
/**
* @if OSPDEPREC
- * Gets the size of @c wchar_t number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c wchar_t number of bytes from the buffer at the current position, converts
* it to the corresponding @c wchar_t equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the GetWchar(wchar_t& value) method.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
+ * Instead of using this method, use the GetWchar(wchar_t& value) method.
* @since 2.0
*
* @return An error code
* @param[out] value The @c wchar_t value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c wchar_t.
- * @remarks This method reads the next size of @c wchar_t number of bytes at the current position,
- * composing it into a @c wchar_t value, and then increments the position by the size of @c wchar_t.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value.
+ * @remarks This method reads the next size of the @c wchar_t number of bytes at the current position,
+ * converts it into a @c wchar_t value, and then increments the position by the size of the @c wchar_t value.
* @see SetMchar()
* @endif
*/
result GetMchar(wchar_t& value);
/**
- * Gets the size of @c wchar_t number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c wchar_t number of bytes from the buffer at the current position, converts
* it to the corresponding @c wchar_t equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c wchar_t value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c wchar_t.
- * @remarks This method reads the next size of @c wchar_t number of bytes at the current position,
- * composing it into a @c wchar_t value, and then increments the position by the size of @c wchar_t.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value.
+ * @remarks This method reads the next size of the @c wchar_t number of bytes at the current position,
+ * converts it into a @c wchar_t value, and then increments the position by the size of the @c wchar_t value.
* @see SetWchar()
*/
result GetWchar(wchar_t& value);
/**
* @if OSPDEPREC
- * Provides a way for absolute indexing and reading. @n
- * It reads the size of @c wchar_t number of bytes at the given index and converts it to equivalent @c wchar_t value.
+ * Provides a way to perform absolute indexing and reading. @n
+ * It reads the size of the @c wchar_t number of bytes at the given @c index and converts it to the equivalent @c wchar_t value.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the GetWchar(int index, wchar_t& value) method.
+ * Instead of using this method, use the GetWchar(int index, wchar_t& value) method.
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c wchar_t value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c wchar_t value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c wchar_t or less than @c 0.
- * @remarks This method reads the size of @c wchar_t number of bytes at the given index,
- * composing it into a @c wchar_t value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c wchar_t value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c wchar_t number of bytes at the given @c index
+ * and converts it into a @c wchar_t value.
* @see SetMchar()
* @endif
*/
result GetMchar(int index, wchar_t& value) const;
/**
- * Provides a way for absolute indexing and reading. @n
- * It reads the size of @c wchar_t number of bytes at the given index and converts it to equivalent @c wchar_t value.
+ * Provides a way to perform absolute indexing and reading. @n
+ * It reads the size of the @c wchar_t number of bytes at the given @c index and converts it to the equivalent @c wchar_t value.
*
* @since 2.0
*
* @return An error code
* @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c wchar_t value at the given index
+ * @param[out] value The @c wchar_t value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c wchar_t or less than @c 0.
- * @remarks This method reads the size of @c wchar_t number of bytes at the given index,
- * composing it into a @c wchar_t value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c wchar_t value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c wchar_t number of bytes at the given @c index
+ * and converts it into a @c wchar_t value.
* @see SetWchar()
*/
result GetWchar(int index, wchar_t& value) const;
/**
- * Gets the size of @c short number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c short number of bytes from the buffer at the current position, converts
* it to the corresponding @c short equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * Provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c short value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c short.
- * @remarks This method reads the next size of @c short number of bytes at the current position,
- * composing it into a @c short value, and then increments the position by the size of @c short.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c short value.
+ * @remarks This method reads the next size of the @c short number of bytes at the current position,
+ * converts it into a @c short value, and then increments the position by the size of the @c short value.
* @see SetShort()
*/
result GetShort(short& value);
/**
- * Gets the size of @c short number of bytes at the given index and converts it to the equivalent @c short value. @n
- * Provides a way for absolute indexing and reading.
+ * Gets the size of the @c short number of bytes at the given @c index and converts it to the equivalent @c short value. @n
+ * Provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c short value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c short value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c short or less than @c 0.
- * @remarks This method reads the size of @c short number of bytes at the given index,
- * composing it into a @c short value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c short value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c short number of bytes at the given @c index
+ * and converts it into a @c short value.
* @see SetShort()
*/
result GetShort(int index, short& value) const;
/**
- * Copies the remaining bytes of the input %ByteBuffer instance into the calling %ByteBuffer instance
+ * Copies the remaining bytes of the input %ByteBuffer instance into the calling %ByteBuffer instance,
* if the remaining part of the current instance is greater than or equal to the remaining part of the input instance. @n
* Otherwise, the number of bytes copied is equal to the number of remaining elements of the current instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] buffer The source buffer from which bytes are read @n
- * It must not be the calling %ByteBuffer instance.
+ * @param[in] buffer The source buffer from which bytes are read @n
+ * It must not be the calling %ByteBuffer instance.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
*
- * @remarks After the copy operation, the current (destination) buffer's position and the given
- * (source) buffer's position are incremented by the number of elements copied (the lesser of
- * the number of elements remaining in the current buffer and the given buffer). @n
- * If the remaining part of the current instance is greater than or equal to the remaining part of the input instance,
- * the effect of this method is the same as the CopyFrom() method. But when the remaining part of the
- * current instance is less, the CopyFrom() method returns E_OVERFLOW and does not transfer;
+ * @remarks
+ * - After the copy operation, the current (destination) buffer's position and the given
+ * (source) buffer's position are incremented by the number of elements copied (the lesser of
+ * the number of elements remaining in the current buffer and the given buffer).
+ * - If the remaining part of the current instance is greater than or equal to the remaining part of the input instance,
+ * the effect of this method is the same as the CopyFrom() method. @n
+ * If the remaining part of the current instance is less, the %CopyFrom() method returns @c E_OVERFLOW and does not transfer;
* whereas this method copies the number of remaining elements of the current instance.
- * @see CopyFrom()
*
* The following example demonstrates how to use the %ReadFrom() method.
*
result ReadFrom(ByteBuffer& buffer);
/**
- * Sets the @c byte values on the specified array to the current instance of %ByteBuffer.
+ * Sets the @c byte values in the specified array to the current instance of %ByteBuffer.
*
* @since 2.0
*
* @return An error code
- * @param[in] pArray The array from which bytes are read
- * @param[in] index The starting index of the array from where the first @c byte value is read
- * @param[in] length The number of bytes to read from the given array
+ * @param[in] pArray The array from which the bytes are read
+ * @param[in] index The starting index of the array from where the first @c byte value is read
+ * @param[in] length The number of bytes to read from the given array
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c pArray is @c null.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index or length is less than @c 0.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes are smaller than @c length.
- * @remarks This method copies the specified number (@c length) of @c byte values into
- * the calling object of buffer from the source array,
- * starting from the current position, and at the given index in the array.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c pArray is @c null.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index or the specified @c length is less than @c 0.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes are smaller than the specified @c length.
+ * @remarks This method copies the specified number (@c length) of @c byte values from the source array
+ * into the calling object of the buffer, starting from the current position,
+ * and at the given index in the array. @n
* After the copy operation, the position is incremented by @c length.
* @see GetArray()
*/
/**
* Sets the given @c byte value into the calling %ByteBuffer object
* at the current position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c byte value to write to the current instance of %ByteBuffer
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the current position is not smaller than the limit.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The current position is not smaller than the limit.
* @see GetByte()
*/
result SetByte(byte value);
/**
- * Sets the given @c byte value into the calling %ByteBuffer object at the specified index. @n
- * Provides a way for absolute indexing and writing.
+ * Sets the given @c byte value into the calling %ByteBuffer object at the specified @c index. @n
+ * Provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current instance of %ByteBuffer at which the byte is written
- * @param[in] value The @c byte value to write
+ * @param[in] index The index of the current instance of %ByteBuffer at which the byte is written
+ * @param[in] value The @c byte value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is not smaller than the limit or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is not smaller than the limit.
+ * - The specified @c index is less than @c 0.
* @see GetByte()
*/
result SetByte(int index, byte value);
/**
* Sets the given @c double value into the calling %ByteBuffer object
* at the current position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c double value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than the size of @c double.
- * @remarks This method writes the size of @c double number of bytes containing the given @c double value
- * into the calling buffer, at the current position, and then increments the position by the size of @c double.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c double value.
+ * @remarks This method writes the size of the @c double number of bytes containing the given @c double value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c double value.
* @see GetDouble()
*/
result SetDouble(double value);
/**
* Sets the given @c float value into the calling %ByteBuffer object
* at the current position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c float value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than the size of @c float.
- * @remarks This method writes the size of @c float number of bytes containing the given @c float value
- * into this buffer at the current position, and then increments the position by the size of @c float.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c float value.
+ * @remarks This method writes the size of the @c float number of bytes containing the given @c float value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c float value.
* @see GetFloat()
*/
result SetFloat(float value);
/**
* Sets the given @c int value into the calling %ByteBuffer instance at the current
* position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c int value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than the size of @c int.
- * @remarks This method writes the size of @c int number of bytes containing the given @c int value
- * into this buffer at the current position, and then increments the position by the size of @c int.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c int value.
+ * @remarks This method writes the size of the @c int number of bytes containing the given @c int value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c int value.
* @see GetInt()
*/
result SetInt(int value);
/**
* Sets the given @c long value into the calling %ByteBuffer instance at the current
* position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c long value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than size of @c long.
- * @remarks This method writes the size of @c long number of bytes containing the given @c long value
- * into this buffer at the current position, and then increments the position by the size of @c long.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c long value.
+ * @remarks This method writes the size of the @c long number of bytes containing the given @c long value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c long value.
* @see GetLong()
*/
result SetLong(long value);
/**
- * Sets the given @c long @c long value into the calling %ByteBuffer object at the current
+ * Sets the given @c long @c long value into the calling %ByteBuffer instance at the current
* position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c long @c long value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than the size of @c long @c long.
- * @remarks This method writes the size of @c long @c long number of bytes containing the given @c long @c long value
- * into this buffer at the current position, and then increments the position by the size of @c long @c long.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c long @c long value.
+ * @remarks This method writes the size of the @c long @c long number of bytes containing the given @c long @c long value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c long @c long value.
* @see GetLongLong()
*/
result SetLongLong(long long value);
/**
* @if OSPDEPREC
- * Sets the given @c wchar_t value into the calling %ByteBuffer object at the current
+ * Sets the given @c wchar_t value into the calling %ByteBuffer instance at the current
* position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the SetWchar(wchar_t value) method.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
+ * Instead of using this method, use the SetWchar(wchar_t value) method.
* @since 2.0
*
* @return An error code
* @param[in] value The @c wchar_t value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than size of @c wchar_t.
- * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value
- * into this buffer at the current position, and then increments the position by the size of @c wchar_t.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value.
+ * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c wchar_t value.
* @see GetMchar()
* @endif
*/
result SetMchar(wchar_t value);
/**
- * Sets the given @c wchar_t value into the calling %ByteBuffer object at the current
+ * Sets the given @c wchar_t value into the calling %ByteBuffer instance at the current
* position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c wchar_t value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than size of @c wchar_t.
- * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value
- * into this buffer at the current position, and then increments the position by the size of @c wchar_t.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value.
+ * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c wchar_t value.
* @see GetWchar()
*/
result SetWchar(wchar_t value);
/**
- * Sets the given @c short value into the current instance of %ByteBuffer at the current
+ * Sets the given @c short value into the current %ByteBuffer instance at the current
* position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * Provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c short value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than the size of @c short.
- * @remarks This method writes the size of @c short number of bytes containing the given @c short value
- * into this buffer at the current position, and then increments the position by the size of @c short.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c short value.
+ * @remarks This method writes the size of the @c short number of bytes containing the given @c short value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c short value.
* @see GetShort()
*/
result SetShort(short value);
/**
- * Sets a @c double value at the specified index of the current instance of %ByteBuffer. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c double value at the specified @c index of the current %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of current instance of %ByteBuffer at which the bytes are written
- * @param[in] value The @c double value to write
+ * @param[in] index The index of the current instance of %ByteBuffer at which the bytes are written
+ * @param[in] value The @c double value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c double or less than @c 0.
- * @remarks This method writes the size of @c double number of bytes containing the given @c double value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c double value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c double number of bytes containing the given @c double value
+ * into the calling buffer, at the given @c index.
* @see GetDouble()
*/
result SetDouble(int index, double value);
/**
- * Sets a @c float value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c float value at the specified @c index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of current instance of %ByteBuffer at which the bytes are written
- * @param[in] value The @c float value to write
+ * @param[in] index The index of the current instance of %ByteBuffer at which the bytes are written
+ * @param[in] value The @c float value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c float or less than @c 0.
- * @remarks This method writes the size of @c float number of bytes containing the given @c float value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c float value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c float number of bytes containing the given @c float value
+ * into the calling buffer, at the given @c index.
* @see GetFloat()
*/
result SetFloat(int index, float value);
/**
- * Sets a @c int value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c int value at the specified @c index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of current instance of %ByteBuffer at which the bytes are written
- * @param[in] value The @c int value to write
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c int or less than @c 0.
- * @remarks This method writes the size of @c int number of bytes containing the given @c int value
- * into this buffer at the given index.
+ * @param[in] index The index of the current instance of %ByteBuffer at which the bytes are written
+ * @param[in] value The @c int value to write
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c int value.
+ * - The specified @c index is less than @c 0
+ * @remarks This method writes the size of the @c int number of bytes containing the given @c int value
+ * into the calling buffer, at the given @c index.
* @see GetInt()
*/
result SetInt(int index, int value);
/**
- * Sets a @c long value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c long value at the specified index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the bytes are written
- * @param[in] value The @c long value to write
+ * @param[in] index The index at which the bytes are written
+ * @param[in] value The @c long value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c long or less than @c 0.
- * @remarks This method writes size of @c long number of bytes containing the given @c long value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c long value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c long number of bytes containing the given @c long value
+ * into the calling buffer, at the given @c index.
* @see GetLong()
*/
result SetLong(int index, long value);
/**
- * Sets a @c long @c long value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c long @c long value at the specified @c index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the bytes will be written
- * @param[in] value The @c long @c long value to write
+ * @param[in] index The index at which the bytes are written
+ * @param[in] value The @c long @c long value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c long @c long or less than @c 0.
- * @remarks This method writes the size of @c long @c long number of bytes containing the given @c long @c long value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c long @c long value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c long @c long number of bytes containing the given @c long @c long value
+ * into the calling buffer, at the given @c index.
* @see GetLongLong()
*/
result SetLongLong(int index, long long value);
/**
* @if OSPDEPREC
- * Sets a @c wchar_t value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c wchar_t value at the specified @c index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the SetWchar(int index, wchar_t value) method.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
+ * Instead of using this method, use the SetWchar(int index, wchar_t value) method.
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the bytes will be written
- * @param[in] value The @c wchar_t value to write
+ * @param[in] index The index at which the bytes are written
+ * @param[in] value The @c wchar_t value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c wchar_t or less than @c 0.
- * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c wchar_t value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value
+ * into the calling buffer, at the given @c index.
* @see GetMchar()
* @endif
*/
result SetMchar(int index, wchar_t value);
/**
- * Sets a @c wchar_t value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c wchar_t value at the specified @c index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the bytes will be written
+ * @param[in] index The index at which the bytes are written
* @param[in] value The @c wchar_t value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c wchar_t or less than @c 0.
- * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c wchar_t value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value
+ * into the calling buffer, at the given @c index.
* @see GetWchar()
*/
result SetWchar(int index, wchar_t value);
/**
- * Sets a @c short value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c short value at the specified @c index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of at which the bytes are written
- * @param[in] value The @c short value to write
+ * @param[in] index The index of at which the bytes are written
+ * @param[in] value The @c short value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c short or less than @c 0.
- * @remarks This method writes the size of @c short number of bytes containing the given @c short value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c short value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c short number of bytes containing the given @c short value
+ * into the calling buffer, at the given @c index.
* @see GetShort()
*/
result SetShort(int index, short value);
/**
* Creates a new %ByteBuffer whose content is a shared portion of
- * the content of the calling %ByteBuffer object.
+ * the content of the calling %ByteBuffer instance.
*
* @since 2.0
*
- * @return %ByteBuffer pointer to the current position of the calling object
- * @remarks The content of the new buffer starts at the current position of the calling %ByteBuffer object.
- * The new buffer's position is zero, its capacity and limit are
- * the number of bytes remaining of the current instance of %ByteBuffer,
+ * @return A %ByteBuffer pointer to the current position of the calling object
+ * @remarks
+ * - The content of the new buffer starts at the current position of the calling %ByteBuffer object.
+ * - The new buffer's position is zero, its capacity and limit are
+ * the number of bytes remaining in the current instance of %ByteBuffer,
* and its mark is undefined.
*/
ByteBuffer* SliceN(void) const;
/**
- * Gets the pointer to the raw array of the calling buffer. @n
+ * Gets a pointer to the raw array of the calling buffer. @n
* If the capacity is zero, it returns @c null.
*
* @since 2.0
const byte* GetPointer(void) const;
/**
- * Gets the pointer to the raw array of the calling buffer. @n
+ * Gets a pointer to the raw array of the calling buffer. @n
* If the capacity is zero, it returns @c null.
*
* @since 2.1
*
- * @return A pointer(non-const) to the raw array of the calling buffer
+ * @return A pointer (non-constant) to the raw array of the calling buffer
*/
byte* GetPointer(void);
*
* @since 2.0
*
- * @return @c true if the input object equals the calling %ByteBuffer instance, @n
+ * @return @c true if the input Object equals the calling %ByteBuffer instance, @n
* else @c false
- * @param[in] obj The object instance to compare with the calling object
- * @remarks This method returns @c true only if the specified object is also an instance of
- * the %ByteBuffer class, the two buffers have the same number of remaining elements, and the two
- * sequences of remaining elements are equal (considered independent of their starting positions).
+ * @param[in] obj The Object instance to compare with the calling object
+ * @remarks This method returns @c true only if the specified object is also an instance of
+ * the %ByteBuffer class, the two buffers have the same number of remaining elements, and the
+ * sequences of the remaining elements are equal (considered independent of their starting positions).
* @see Tizen::Base::BufferBase::GetHashCode()
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
*
* @since 2.0
*
- * @return The hash value of the current instance
+ * @return The hash value of the current instance
* @remarks The hash code of a buffer depends only upon its remaining elements.
*/
virtual int GetHashCode(void) const;
projects / platform / framework / native / appfw.git / blobdiff