/**
* Method to get the connectivity type for account server
*
- * @return EnumSet<OcConnectivityType></OcConnectivityType> connectivity type set
+ * @return EnumSet OcConnectivityType connectivity type set
*/
public EnumSet<OcConnectivityType> getConnectivityTypeSet() {
return OcConnectivityType.convertToEnumSet(
/**
* API to construct the CloudProvisioning
*
- * @param ipAddr address of the cloud server
+ * @param ip address of the cloud server
* @param port port of the cloud server
*/
public OcCloudProvisioning(String ip, int port) {
/**
* Method to get the connectivity type of this resource
*
- * @return EnumSet<OcConnectivityType></OcConnectivityType> connectivity type set
+ * @return EnumSet OcConnectivityType connectivity type set
*/
public EnumSet<OcConnectivityType> getConnectivityTypeSet() {
return OcConnectivityType.convertToEnumSet(
/**
* Method to get list of all paired devices for a given device.
*
- * @param GetDirectPairedListener Callback function, which will receive the list of direct paired devices.
+ * @param getDirectPairedListener Callback function, which will receive the list of direct paired devices.
* @throws OcException
*/
/**
* Method to perform direct pairing between two devices.
*
- * @param DirectPairingListener Callback function, which will be called after
+ * @param directPairingListener Callback function, which will be called after
* completion of direct pairing.
* @throws OcException
*/
package org.iotivity.base;
import org.iotivity.ca.CaInterface;
-import org.iotivity.base.BuildConfig;
+import org.iotivity.base.*;
import java.util.EnumSet;
import java.util.Iterator;
/**
* This API registers a resource with the server
- * <p/>
- * Note: This API applies to server & client side.
+ * <p>
+ * Note: This API applies to server and client side.
* </P>
*
* @param ocResource The instance of OcResource with all data filled
/**
* This API registers a resource with the server NOTE: This API applies to server side only.
- * <p/>
+ * <p>
* Note: This API applies to server side only.
* </P>
*
/**
* Set param Info
*
- * @param ocDeviceInfo object containing all the device specific information
- * @throws OcException if failure
+ * @throws OcException on failure
*/
public static void setPropertyValue(
int path, String propName, String propValue) throws OcException {
* Method to find all devices which are eligible for direct pairing and return the list.
*
* @param timeout timeout for discovering direct pair devices.
- * @param FindDirectPairingListener Callback function, which will receive the list of direct
+ * @param onFindDirectPairingListener Callback function, which will receive the list of direct
* pairable devices.
* @throws OcException
*/
/**
* Method to get list of all paired devices for a given device.
*
- * @param GetDirectPairedListener Callback function, which will receive the list of direct
+ * @param onGetDirectPairedListener Callback function, which will receive the list of direct
* paired devices.
* @throws OcException
*/
* @param peer Target peer
* @param prmType Pairing Method to be used for Pairing
* @param pin pin
- * @param DirectPairingListener Callback function, which will be called after
+ * @param onDirectPairingListener Callback function, which will be called after
* completion of direct pairing.
* @throws OcException
*/
* An EntityHandler can be registered via the OcPlatform.registerResource call.
* Event listeners are notified asynchronously
*
- * @note entityhandler callback :
+ * Note: entityhandler callback :
* When you set specific return value like EntityHandlerResult.OK, SLOW
* and etc in entity handler callback,
* ocstack will be not send response automatically to client
* You can only create this object if OCPlatform was initialized to be a Client or
* Client/Server. Otherwise, this will return an empty shared ptr.
*
- * @note For now, OCPlatform SHOULD be initialized to be a Client/Server(Both) for the
+ * Nnote For now, OCPlatform SHOULD be initialized to be a Client/Server(Both) for the
* methods of this object to work since device id is not generated on Client mode.
*
* @param host Host IP Address of a account server.
/**
* construct OcPlatformInfo with mandatory fields which cannot be null
- * manufacturerName cannot be > 16 chars
- * manufacturerUrl cannot be > 32 chars
+ * manufacturerName cannot be greater than 16 chars
+ * manufacturerUrl cannot be greater than 32 chars
*/
public OcPlatformInfo(String platformId, String manufacturerName,
String manufacturerUrl) {
/**
* Server API to set Callback for Displaying stack generated PIN.
*
- * @param DisplayPinListener Pin callback Listener to be registered.
+ * @param displayPinListener Pin callback Listener to be registered.
* @throws OcException
*/
public static native void setDisplayPinListener(DisplayPinListener displayPinListener)
* Method to get Array of owned and un-owned devices in the current subnet.
*
* @param timeout timeout in sec for the API to return.
- * @retrun Array of OcSecureResource class objects.
+ * @return Array of OcSecureResource class objects.
* be provisioned.
* @throws OcException
*/
/**
* Method to save the Trust certificate chain to SVR.
*
- * @param byte[] trustCertChain
- * @param EncodingType encodingType
+ * @param trustCertChain
+ * @param encodingType
* @throws OcException
*/
public static int saveTrustCertChain(byte[] trustCertChain, EncodingType encodingType) throws OcException {
/**
* Method to set header options
*
- * @param headerOptionList List<OcHeaderOption> where header information(header optionID and
+ * @param headerOptionList List OcHeaderOption where header information(header optionID and
* optionData is passed
* @throws OcException
*/
/**
* Method to get the connectivity type of this resource
*
- * @return EnumSet<OcConnectivityType></OcConnectivityType> connectivity type set
+ * @return EnumSet OcConnectivityType connectivity type set
*/
public EnumSet<OcConnectivityType> getConnectivityTypeSet() {
return OcConnectivityType.convertToEnumSet(
/**
* Method to Start Ownership Transfer of an un-owned device.
*
- * @param DoOwnershipTransferListener Callback function, which will be called after
+ * @param doOwnershipTransferListener Callback function, which will be called after
* completion of ownership Transfer.
* @throws OcException
*/
* Method removes device credential from all devices in subnet
*
* @param timeout
- * @param RemoveDeviceListener Callback function, which will be called after
+ * @param removeDeviceListener Callback function, which will be called after
* completion of removing device.
* @throws OcException
*/
throws OcException;
/**
- * Method removes the credential & relationship between the two devices.
+ * Method removes the credential and relationship between the two devices.
*
- * @param jobject Second device
- * @param UnlinkDevicesListener Callback function, which will be called after
+ * @param device2 Second device
+ * @param unlinkDevicesListener Callback function, which will be called after
* completion of removing device.
* @throws OcException
*/
throws OcException;
/**
- * Method removes the credential & relationship between the two devices.
+ * Method removes the credential and relationship between the two devices.
*
- * @param EnumSet<CredType> OR'ed Cred Types
- * @param KeySize keySize
- * @param Object Second device
- * @param ProvisionCredentialsListener Callback function, which will be called after
+ * @param credTypeSet OR'ed Cred Types
+ * @param keysize
+ * @param device2 Second device
+ * @param provisionCredentialsListener Callback function, which will be called after
* completion of removing device.
* @throws OcException
*/
/**
* Method to provision the Trust certificate chain to secured device.
*
- * @param EnumSet<CredType> OR'ed Cred Types
- * @param int credId
- * @param ProvisionTrustCertChainListener Callback function, which will be called after
+ * @param credTypeSet OR'ed Cred Types
+ * @param credId
+ * @param provisionTrustCertChainListener Callback function, which will be called after
* proviosion trust certificate chain.
* @throws OcException
*/
/**
* Method send ACL information to resource.
*
- * @param jobject Acl
- * @param ProvisionAclListener Callback function, which will be called after
+ * @param acl object
+ * @param provisionACLListener Callback function, which will be called after
* completion of removing device.
* @throws OcException
*/
* Method provisions credentials between two devices and ACLs for the devices who
* act as a server.
*
- * @param EnumSet<CredType> OR'ed Cred Types
- * @param KeySize keySize
- * @param Object First acl
- * @param Object Second device
- * @param Object Second acl
- * @param ProvisionPairwiseDevicesListener Callback function, which will be called after
+ * @param credTypeSet OR'ed Cred Types
+ * @param keysize keySize
+ * @param acl1 First acl
+ * @param device2 Second device
+ * @param acl2 Second acl
+ * @param provisionPairwiseDevicesListener Callback function, which will be called after
* completion of removing device.
* @throws OcException
*/
* @param pdacls Array of Device Pairing Access Control List
* @param type List of supported OcPrmType
* @param edp enable (1) / disable (0)
- * @param ProvisionDirectPairing Callback function, which will be called after completion
+ * @param provisionDirectPairingListener Callback function, which will be called after completion
* of Direct Pairing.
* @throws OcException
*/
*/
public enum ResourceProperty {
/**
- * When none of the bits are set, the resource is non-discoverable &
+ * When none of the bits are set, the resource is non-discoverable and
* non-observable by the client.
*/
RES_PROP_NONE(0),
/**
* set BLE scan interval time and working count.
- * scanning logic (start scan -> stop scan) will be worked repeatly for workingCount.
+ * scanning logic ("start scan" to "stop scan") will be worked repeatly for workingCount.
* and if you choose '0' value for workingCount parameter,
* scanning will be worked continually as interval time.
* @param intervalTime interval time(Seconds).
import org.iotivity.service.easysetup.mediator.enums.ESResult;
/**
- * This interface facilitates Application to get progress & result of Cloud provisioning
- * process in easy setup
+ * This interface facilitates Application
+ * to get progress and result of Cloud provisioning process in easy setup
*/
public class CloudPropProvisioningStatus
{
* Constructor
*
* @param result a result of cloud property provisioning
- * @param state a state of cloud property provisioning.
+ * <p> state a state of cloud property provisioning.
* ES_CLOUD_PROVISIONING_ERROR(-1), ES_CLOUD_PROVISIONING_SUCCESS(0),
* ES_CLOUD_ENROLLEE_FOUND(1), ES_CLOUD_ENROLLEE_NOT_FOUND(2)
- *
+ * </p>
* @see ESCloudProvState
*/
public CloudPropProvisioningStatus(int result)
/**
* Get a result of cloud property provisioning
*
- * @result ESResult a result of cloud property provisioning
+ * @return ESResult a result of cloud property provisioning
*/
public ESResult getESResult()
{
import android.util.Log;
/**
- * @class MediaContents
- * @brief This class provides implementation of Notification MediaContents object.
- */
+ * This class provides implementation of Notification MediaContents object.
+ */
public class MediaContents
{
private static final String LOG_TAG = "NotificationService_MediaContents";
import org.iotivity.base.OcRepresentation;
/**
- * @class Message
- * @brief This class provides implementation of Notification Message object.
- */
+ * This class provides implementation of Notification Message object.
+ */
public class Message
{
private static final String LOG_TAG = "NotificationService_Message";
import android.util.Log;
/**
- * @class SyncInfo
- * @brief This class provides implementation of Notification SyncInfo object.
- */
+ * Implementation of Notification SyncInfo object.
+ */
public class SyncInfo
{
private static final String LOG_TAG = "NotificationService_SyncInfo";
package org.iotivity.service.ns.common;
import android.util.Log;
/**
- * @class Topic
- * @brief This class provides implementation of Notification Topic object.
- */
+ * Provides implementation of Notification Topic object.
+ */
public class Topic
{
private static final String LOG_TAG = "NotificationService_Topic";
import java.util.Vector;
import java.util.Iterator;
/**
- * @class TopicsList
- * @brief This class provides implementation of Topics List
- */
+ * provides implementation of Topics List
+ */
public class TopicsList
{
private static final String LOG_TAG = "NotificationService_TopicList";
import java.util.Vector;
/**
- * @class ConsumerService
- * @brief This class provides a set of Java APIs for Notification Consumer.
+ * This class provides a set of Java APIs for Notification Consumer.
*/
public class ConsumerService
{
/**
* Request to publish resource to cloud server
- * @param[in] serverAddress combined with IP address and port number using delimiter :
- * @return result code
+ * @param serverAddress combined with IP address and port number using delimiter [in]
*/
public void enableRemoteService(String serverAddress) throws NSException
{
import java.util.Vector;
/**
- * @class Provider
- * @brief This class provides implementation of Notification Provider object.
+ * This class provides implementation of Notification Provider object.
*/
public class Provider
{
import org.iotivity.service.ns.common.*;
import java.util.Vector;
/**
- * @class Consumer
- * @brief This class provides implementation of Notification Consumer object.
+ * Provides implementation of Notification Consumer object.
*/
public class Consumer
{
public native int nativeSetConsumerTopic(String consumerId, String topicName) throws NSException;
public native int nativeUnsetConsumerTopic(String consumerId, String topicName) throws NSException;
public native TopicsList nativeGetConsumerTopicList(String consumerId) throws NSException;
-}
\ No newline at end of file
+}
import org.iotivity.service.ns.common.*;
import java.util.Vector;
/**
- * @class ProviderService
- * @brief This class provides a set of Java APIs for Notification ProviderService.
- */
+ * Provides a set of Java APIs for Notification ProviderService.
+ */
public class ProviderService
{
/**
* Request to publish resource to cloud server
- * @param[in] servAdd combined with IP address and port number using delimiter :
+ * @param servAdd combined with IP address and port number using delimiter [in]
* @return result code
*/
public int enableRemoteService(String servAdd) throws NSException
/**
* Request to cancel remote service using cloud server
- * @param[in] servAdd combined with IP address and port number using delimiter :
+ * @param servAdd combined with IP address and port number using delimiter :
* @return result code
*/
public int disableRemoteService(String servAdd) throws NSException
/**
* Set the attribute (map to a send command for the according protocol)
*
- * @param key
- * name of the attribute to be set
* @param value
* new value of the attribute
*/
/**
* Retrieve the attribute (map to read command)
- *
- * @param key
- * name of the attribute to be set
- * @param value
- * new value of the attribute
*/
public abstract RcsResourceAttributes handleGetAttributesRequest();
* @param key
* key with which the specified value is to be associated
*
- * @param value
+ * @param object
* value to be associated with the specified key
*
* @throws NullPointerException
/**
* API for getting the list of all bundles in the container
*
- * @return list<RCSBundleInfo> -List of BundleInfo objects each associated
+ * @return List of BundleInfo objects each associated
* with a bundle
*
* {@link RcsBundleInfo}
* @param bundleId
* Id of the Bundle
*
- * @return List<String> All the bundle resources
+ * @return List of all the bundle resources
*/
public List<String> listBundleResources(String bundleId) {
if(bundleId == null || bundleId.isEmpty()){
* @param bundleId
* Id of the Bundle
*
- * @return List<ResourceConfig> All the resource configurations for the given bundle
+ * @return All the resource configurations for the given bundle
*/
public List<ResourceConfig> getConfiguredBundleResources(String bundleId) {
Log.d(TAG, "getConfiguredBundleResource " + bundleId);
* @param key
* key with which the specified value is to be associated
*
- * @param value
+ * @param object
* value to be associated with the specified key
*
* @throws NullPointerException
/**
* Register a resource and returns a RCSResourceObject.
*
- * @throws RcsPlatformException
+ * throws RcsPlatformException
* If registering a resource is failed.
- *
+ * (TODO check)
*/
public RcsResourceObject build() {
return nativeBuild(mUri, mType, mInterface, mIsObservable,
*
* @throws RcsIllegalStateException
* if not in locked state
- * @throws RcsPlatformException
+ * or RcsPlatformException
* if auto notify failed
*/
public void apply() throws RcsIllegalStateException {
projects / platform / upstream / iotivity.git / commitdiff