Skip to content

Commit 2fc4739

Browse files
committed
Minor change in javadocs and dummy test added
1 parent 66d1938 commit 2fc4739

4 files changed

Lines changed: 26 additions & 15 deletions

File tree

build.gradle.kts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ version = "0.1.2"
33
description = "Physical adapter to connect with the CoAP protocol"
44
java.sourceCompatibility = JavaVersion.VERSION_1_8
55

6+
67
plugins {
78
id("com.vanniktech.maven.publish") version "0.35.0"
89
`java-library`

src/main/java/it/wldt/adapter/coap/physical/CoapPhysicalAdapter.java

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -81,19 +81,15 @@ public void onIncomingPhysicalAction(PhysicalAssetActionWldtEvent<?> physicalAct
8181
}
8282

8383
/**
84-
* Starts the CoAP physical adapter.
85-
* <p>
86-
* This method performs the following operations:
87-
* <ul>
88-
* <li>Discovers available resources using the {@code discoverResources()} method.</li>
89-
* <li>Checks the presence of resources; if no resources are found, notifies that the adapter is unbound.</li>
90-
* <li>Starts listening to the found resources.</li>
91-
* <li>Generates the physical asset description (PAD) containing properties, events, and actions of the resources.</li>
92-
* <li>If enabled, handles observability and automatic updates for resources.</li>
93-
* </ul>
84+
*Starts the CoAP physical adapter.
85+
*This method performs the following operations:
86+
*- Discovers available resources using the {@code discoverResources()} method.
87+
*- Checks the presence of resources; if no resources are found, notifies that the adapter is unbound.
88+
*- Starts listening to the found resources.
89+
*- Generates the physical asset description (PAD) containing properties, events, and actions of the resources.
90+
*If enabled, handles observability and automatic updates for resources.
9491
* Once the method has performed all its operations without errors, it notifies that the adapter is successfully bound.
9592
* If any errors occur during execution, appropriate logs are recorded, and the adapter is notified as unbound.
96-
* </p>
9793
*/
9894
@Override
9995
public void onAdapterStart() {

src/main/java/it/wldt/adapter/coap/physical/configuration/CoapPhysicalAdapterConfigurationBuilder.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ public CoapPhysicalAdapterConfigurationBuilder addCustomEventType(String resourc
128128
}
129129

130130
/**
131-
* Adds a WLDT action type only to the specified resource supporting both POST & PUT requests.
131+
* Adds a WLDT action type only to the specified resource supporting both POST and PUT requests.
132132
* @param resourceName The resource to apply the type to.
133133
* @param actionType The WLDT action type.
134134
* @return The builder instance.
@@ -139,7 +139,7 @@ public CoapPhysicalAdapterConfigurationBuilder addCustomActionType(String resour
139139
}
140140

141141
/**
142-
* Sets the default WLDT action type for CoAP resources supporting both POST & PUT requests.
142+
* Sets the default WLDT action type for CoAP resources supporting both POST and PUT requests.
143143
* @param actionType The WLDT action type
144144
* @return The builder instance.
145145
*/
@@ -180,7 +180,7 @@ public CoapPhysicalAdapterConfigurationBuilder addCustomActionContentType(String
180180
}
181181

182182
/**
183-
* Sets the default WLDT action content type for CoAP resources supporting both POST & PUT requests.
183+
* Sets the default WLDT action content type for CoAP resources supporting both POST and PUT requests.
184184
* @param actuatorActionContentType The WLDT action type
185185
* @return The builder instance.
186186
*/
@@ -399,7 +399,7 @@ public CoapPhysicalAdapterConfigurationBuilder setCustomPropertyRequestFunction(
399399
}
400400

401401
/**
402-
* Sets the function which sends CoAP POST & PUT request to the Physical Asset.
402+
* Sets the function which sends CoAP POST and PUT request to the Physical Asset.
403403
* @param customActionRequestFunction A function which receives a CoAP request as input and returns the CoAP response.
404404
* @return The builder instance.
405405
*/
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
package it.wldt.adapter.coap.physical;
2+
3+
import org.junit.Test;
4+
5+
import static org.junit.Assert.assertTrue;
6+
7+
public class DummyTest {
8+
9+
@Test
10+
public void dummyTest() {
11+
assertTrue(true);
12+
}
13+
14+
}

0 commit comments

Comments
 (0)