Skip to content

Commit 36ec6af

Browse files
CopilotTheMeinerLP
andcommitted
Update Javadoc tags, add class logger, and fix Mermaid diagram
Co-authored-by: TheMeinerLP <[email protected]>
1 parent cc8ec21 commit 36ec6af

File tree

4 files changed

+20
-24
lines changed

4 files changed

+20
-24
lines changed

SERVICE_ARCHITECTURE.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,24 +37,16 @@ The architecture follows the Service Layer pattern with abstraction to allow mul
3737
graph TD
3838
A[Client Code<br/>Plugin, Listeners, Commands] --> B[Service Interface<br/>RedstoneClockService]
3939
B --> C[Service Factory<br/>RedstoneClockServiceFactory]
40-
C --> D[Platform Detection<br/>isFolia()]
40+
C --> D[Platform Detection<br/>isFolia]
4141
D --> E[BukkitRedstoneClockService<br/>Standard Bukkit Implementation]
4242
D --> F[FoliaRedstoneClockService<br/>Region-aware Implementation]
4343
44-
style A fill:#e1f5fe
45-
style B fill:#f3e5f5
46-
style C fill:#fff3e0
47-
style D fill:#fce4ec
48-
style E fill:#e8f5e8
49-
style F fill:#fff8e1
50-
51-
classDef interfaceBox fill:#f3e5f5,stroke:#9c27b0,stroke-width:2px
52-
classDef factoryBox fill:#fff3e0,stroke:#ff9800,stroke-width:2px
53-
classDef implBox fill:#e8f5e8,stroke:#4caf50,stroke-width:2px
54-
55-
class B interfaceBox
56-
class C,D factoryBox
57-
class E,F implBox
44+
style A fill:#e1f5fe,stroke:#01579b,stroke-width:2px
45+
style B fill:#f3e5f5,stroke:#9c27b0,stroke-width:2px
46+
style C fill:#fff3e0,stroke:#ff9800,stroke-width:2px
47+
style D fill:#fce4ec,stroke:#e91e63,stroke-width:2px
48+
style E fill:#e8f5e8,stroke:#4caf50,stroke-width:2px
49+
style F fill:#fff8e1,stroke:#ff9800,stroke-width:2px
5850
```
5951

6052
## Components

src/main/java/net/onelitefeather/antiredstoneclockremastered/service/api/RedstoneClockService.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
* Service interface for managing redstone clock detection and handling.
1414
* This abstraction allows for different implementations (e.g., Bukkit, Folia).
1515
*
16-
* @author OneLiteFeather
17-
* @version 1.0.0
16+
* @author TheMeinerLP
17+
* @version 2.2.0
1818
* @since 1.0.0
1919
*/
2020
public interface RedstoneClockService {

src/main/java/net/onelitefeather/antiredstoneclockremastered/service/factory/RedstoneClockServiceFactory.java

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,21 @@
66
// import net.onelitefeather.antiredstoneclockremastered.service.impl.FoliaRedstoneClockService;
77
import io.papermc.paper.ServerBuildInfo;
88
import org.jetbrains.annotations.NotNull;
9+
import org.slf4j.Logger;
10+
import org.slf4j.LoggerFactory;
911

1012
/**
1113
* Factory for creating RedstoneClockService implementations.
1214
* This factory determines the appropriate implementation based on the server platform.
1315
*
14-
* @author OneLiteFeather
15-
* @version 1.0.0
16+
* @author TheMeinerLP
17+
* @version 2.2.0
1618
* @since 1.0.0
1719
*/
1820
public final class RedstoneClockServiceFactory {
1921

22+
private static final Logger LOGGER = LoggerFactory.getLogger(RedstoneClockServiceFactory.class);
23+
2024
private RedstoneClockServiceFactory() {
2125
// Utility class
2226
}
@@ -30,13 +34,13 @@ private RedstoneClockServiceFactory() {
3034
@NotNull
3135
public static RedstoneClockService createService(@NotNull AntiRedstoneClockRemastered plugin) {
3236
if (isFolia()) {
33-
plugin.getLogger().info("Folia detected - using FoliaRedstoneClockService");
37+
LOGGER.info("Folia detected - using FoliaRedstoneClockService");
3438
// Uncomment when ready to enable Folia support:
3539
// return new FoliaRedstoneClockService(plugin);
36-
plugin.getLogger().warning("Folia implementation not yet ready, falling back to Bukkit implementation");
40+
LOGGER.warn("Folia implementation not yet ready, falling back to Bukkit implementation");
3741
}
3842

39-
plugin.getLogger().info("Using BukkitRedstoneClockService");
43+
LOGGER.info("Using BukkitRedstoneClockService");
4044
return new BukkitRedstoneClockService(plugin);
4145
}
4246

src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/BukkitRedstoneClockService.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
* Bukkit/Paper implementation of the RedstoneClockService.
2828
* This implementation uses the standard Bukkit scheduler and APIs.
2929
*
30-
* @author OneLiteFeather
31-
* @version 1.0.0
30+
* @author TheMeinerLP
31+
* @version 2.2.0
3232
* @since 1.0.0
3333
*/
3434
public final class BukkitRedstoneClockService implements RedstoneClockService {

0 commit comments

Comments
 (0)