Skip to content

Commit 5c33a15

Browse files
committed
- made API interface object constructors and instance accessors private
(mainly for clean docs)
1 parent 069d31c commit 5c33a15

File tree

9 files changed

+46
-24
lines changed

9 files changed

+46
-24
lines changed

build.gradle

+3-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ jar {
4040
}
4141

4242
task generateApiDocs(type: Javadoc) {
43-
source = fileTree("src/main/java/com/tellerulam/logic4mqtt/api")
43+
source = fileTree("src/main/java/com/tellerulam/logic4mqtt/api").matching {
44+
exclude "InstanceManager.java"
45+
}
4446
destinationDir = file("apidocs")
4547
options.setMemberLevel(JavadocMemberLevel.PUBLIC)
4648
}

src/main/java/com/tellerulam/logic4mqtt/NattyTimer.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public void start()
3636
/* Overridable for unit testing only */
3737
protected Time getTimeInstance()
3838
{
39-
return Time.getInstance();
39+
return InstanceManager.getTimeInstance();
4040
}
4141

4242
public static class ParsedSpec

src/main/java/com/tellerulam/logic4mqtt/ScriptScanner.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ static private ScriptEngine getEngine(String ext)
4040
if(se!=null)
4141
{
4242
// Configure the engine
43-
se.put("Events", Events.getInstance());
44-
se.put("Timers", Timers.getInstance());
45-
se.put("Utilities", Utilities.getInstance());
46-
se.put("Time", Time.getInstance());
43+
se.put("Events", InstanceManager.getEventsInstance());
44+
se.put("Timers", InstanceManager.getTimersInstance());
45+
se.put("Utilities", InstanceManager.getUtilitiesInstance());
46+
se.put("Time", InstanceManager.getTimeInstance());
4747
engines.put(ext,se);
4848
}
4949
}

src/main/java/com/tellerulam/logic4mqtt/api/Events.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111

1212
public class Events
1313
{
14-
private static final Events instance=new Events();
14+
static final Events instance=new Events();
1515

16-
public static Events getInstance()
16+
private Events()
1717
{
18-
return instance;
18+
/* Keep private */
1919
}
2020

2121
/**
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
package com.tellerulam.logic4mqtt.api;
2+
3+
public class InstanceManager
4+
{
5+
public static Events getEventsInstance()
6+
{
7+
return Events.instance;
8+
}
9+
public static Time getTimeInstance()
10+
{
11+
return Time.instance;
12+
}
13+
public static Timers getTimersInstance()
14+
{
15+
return Timers.instance;
16+
}
17+
public static Utilities getUtilitiesInstance()
18+
{
19+
return Utilities.instance;
20+
}
21+
}

src/main/java/com/tellerulam/logic4mqtt/api/Time.java

+7-6
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,13 @@
2323

2424
public class Time
2525
{
26-
private static final Time instance=new Time();
26+
static final Time instance=new Time();
27+
28+
private Time()
29+
{
30+
/* Keep private */
31+
}
32+
2733

2834
private LnLnlatPosn location=new LnLnlatPosn();
2935
{
@@ -382,10 +388,5 @@ public boolean isBetween(String timespec1,String timespec2)
382388
return cal_start.before(now) && cal_end.after(now);
383389
}
384390

385-
public static Time getInstance()
386-
{
387-
return instance;
388-
}
389-
390391
private static Logger L=Logger.getLogger(Time.class.getName());
391392
}

src/main/java/com/tellerulam/logic4mqtt/api/Timers.java

+3-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,10 @@
66

77
public class Timers
88
{
9-
private static final Timers instance=new Timers();
10-
11-
public static Timers getInstance()
9+
static final Timers instance=new Timers();
10+
private Timers()
1211
{
13-
return instance;
12+
/* Keep private */
1413
}
1514

1615
public void addTimer(String symbolicName,String timespec,TimerCallbackInterface callback,Object userdata)

src/main/java/com/tellerulam/logic4mqtt/api/Utilities.java

+3-4
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,10 @@
1313

1414
public class Utilities
1515
{
16-
private static final Utilities instance=new Utilities();
17-
18-
public static Utilities getInstance()
16+
static final Utilities instance=new Utilities();
17+
private Utilities()
1918
{
20-
return instance;
19+
/* Keep private */
2120
}
2221

2322
/**

src/main/java/com/tellerulam/logic4mqtt/cmdline/CmdTimes.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public class CmdTimes extends Cmd
1414
@Override
1515
public void exec(PrintWriter w, ArgSplitter args) throws Exception
1616
{
17-
Time t=Time.getInstance();
17+
Time t=InstanceManager.getTimeInstance();
1818
final String zeniths[]={"ASTRONOMICAL","NAUTICAL","CIVIL","OFFICIAL"};
1919
for(String zenith:zeniths)
2020
{

0 commit comments

Comments
 (0)