//
-// Open Service Platform
// Copyright (c) 2013 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @class AlgorithmIdentifier
- * @brief This class implements the ASN.1 specified AlgorithmIdentifier, which is used for
- * creating the standard AlgorithmIdentifier object.
- * AlgorithmIdentifier structure consist the OID value of the Algorithm
- * and the parameters of that algorithm.
+ * @brief This class implements the ASN.1 specified %AlgorithmIdentifier, which is used for
+ * creating the standard %AlgorithmIdentifier object.
*
- * It is defined in ASN.1 as
+ * @since 2.1
+ *
+ * The %AlgorithmIdentifier class implements the ASN.1 specified %AlgorithmIdentifier, which is used for
+ * creating the standard %AlgorithmIdentifier object. The %AlgorithmIdentifier structure consists of the OID value of the
+ * algorithm along with the parameters of the algorithm.
*
+ * This is defined in ASN.1 as demonstrated in the following code:
+ * @code
* AlgorithmIdentifier { ALGORITHM-IDENTIFIER:InfoObjectSet }
* ::=
* SEQUENCE {
* parameters ALGORITHM-IDENTIFIER.&Type({InfoObjectSet}
* {@algorithm}) OPTIONAL }
* ALGORITHM-IDENTIFIER ::= TYPE-IDENTIFIER
- * @since 2.1
+ * @endcode
*
*/
virtual ~AlgorithmIdentifier(void);
/**
- * Initializes the %AlgorithmIdentifier with supplied input parameters values.
+ * Initializes the %AlgorithmIdentifier with the specified input parameter values.
*
* @since 2.1
*
* @return An error code
- * @param[in] objectId This parameter specifies object Identifier of particular algorithm. Object IDs
- * are defined by standard bodies for algorithms and other crypto objects.Object ID of AlgorithmIdentifier can be described in string format like 1.2.3.4
- * @param[in] pParams This parameter specifies a pointer to AlgorithmParameters object. This is an
- * optional parameter and contains a list of user supplied input parameters for the specified algorithm.
- * For example, for Symmetric algorithms Initial vector (IV) is required as input.
- * The default value of this parameter is NULL.
- * @exception E_SUCCESS The method is successful.
+ * @param[in] objectId The object identifier of a particular algorithm @n
+ * The object IDs are defined by standard bodies for algorithms and other crypto objects. @n
+ * The object ID of %AlgorithmIdentifier can be described in string format like 1.2.3.4
+ * @param[in] pParams A pointer to the AlgorithmParameters object @n
+ * This is an optional parameter and contains a list of user specified input parameters for
+ * the specified algorithm. For example, for Symmetric algorithms Initial vector, IV is required
+ * as an input. The default value of this parameter is @c null.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_UNSUPPORTED_ALGORITHM The object id of the input algorithm is not supported.
+ * @exception E_UNSUPPORTED_ALGORITHM The object ID of the input algorithm is not supported.
*/
result Construct(const Tizen::Base::String& objectId, const IAlgorithmParameters* pParams = null);
/**
- * Initializes this instance of %AlgorithmIdentifier with the DER encoded Bytebuffer that conatins @n
- * the ASN.1 specified AlgorithmIdentifier structure.
+ * Initializes this instance of %AlgorithmIdentifier with the DER encoded Tizen::Base::ByteBuffer that contains
+ * the ASN.1 specified %AlgorithmIdentifier structure.
*
* @since 2.1
*
* @return An error code
- * @param[in] encodedData An instance of DER encoded ByteBuffer
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @param[in] encodedData An instance of DER encoded Tizen::Base::ByteBuffer
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
*/
result Construct(const Tizen::Base::ByteBuffer& encodedData);
/**
* Checks whether the specified instance of %AlgorithmIdentifier equals the current instance.
*
- * @since 2.1
+ * @since 2.1
*
* @return @c true if the specified instance equals the current instance, @n
- * else @c false
- * @param[in] rhs An instance of %AlgorithmIdentifier
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * else @c false
+ * @param[in] rhs An instance of %AlgorithmIdentifier
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
virtual int GetHashCode(void) const;
/**
- * Get the copy of AlgorithmIdentifier instance.
+ * Gets the copy of the %AlgorithmIdentifier instance.
*
* @since 2.1
*
- * @return Pointer to AlgorithmIdentifier, containing the copy of this instance, @n
- * else @c null if an error occurs.
+ * @return A pointer to the %AlgorithmIdentifier instance that is the copy of the specified instance, @n
+ * else @c null if an error occurs
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
AlgorithmIdentifier* CloneN(void) const;
*
* @since 2.1
*
- * @return Pointer to IAlgorithmParameters, containing the parameter list of algorithm, @n
- * else @c null if an no parameters exist.
+ * @return A pointer to the IAlgorithmParameters instance containing the parameter list of algorithm, @n
+ * else @c null if no parameters exist
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
IAlgorithmParameters* GetParametersN(void) const;
/**
- * Gets the object Id value of an algorithm in string format.
+ * Gets the object ID value of an algorithm in string format.
*
- * @since 2.1
+ * @since 2.1
*
- * @return Object ID of AlgorithmIdentifier in string format like 1.2.3.4.
+ * @return The object ID of %AlgorithmIdentifier in string format like 1.2.3.4
*
*/
Tizen::Base::String GetAlgorithmObjectId(void) const;
/**
- * Gets the encoded form of the AlgorithmIdentifier. @n
- * It is assumed that each AlgorithmIdentifier type will have only a single form of encoding that is DER encoding.
+ * Gets the encoded form of the %AlgorithmIdentifier. @n
+ * It is assumed that each %AlgorithmIdentifier type will have only a single form of encoding that is DER encoding.
*
* @since 2.1
*
- * @return Pointer to the DER encoded ByteBuffer, @n
- * else @c null if an error occurs.
+ * @return A pointer to the DER encoded Tizen::Base::ByteBuffer, @n
+ * else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
projects / platform / framework / native / appfw.git / blobdiff