Skip to content

Commit 36f32e6

Browse files
committed
Always use 'log' for LogService variable name
In the vast majority of cases, when referring to a LogService, we name it log rather than logService. This does break the more general rule of referring to most service instances in full lower camel case, but in the case of the LogService, it makes the code more concise yet precise.
1 parent 09caa26 commit 36f32e6

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

src/main/java/org/scijava/command/console/RunArgument.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public class RunArgument extends AbstractConsoleArgument {
5757
private CommandService commandService;
5858

5959
@Parameter
60-
private LogService logService;
60+
private LogService log;
6161

6262
// -- Constructor --
6363

@@ -100,12 +100,12 @@ private void run(final String commandToRun, final String optionString) {
100100
return;
101101

102102
// TODO: parse the optionString a la ImageJ1
103-
final Map<String, Object> inputMap = ConsoleUtils.parseParameterString(optionString, info, logService);
103+
final Map<String, Object> inputMap = ConsoleUtils.parseParameterString(optionString, info, log);
104104

105105
try {
106106
commandService.run(info, true, inputMap).get();
107107
} catch (final Exception exc) {
108-
logService.error(exc);
108+
log.error(exc);
109109
}
110110
}
111111

src/main/java/org/scijava/console/ConsoleUtils.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ public static Map<String, Object> parseParameterString(final String parameterStr
6464
/**
6565
* @see #parseParameterString(String, ModuleInfo, LogService)
6666
*/
67-
public static Map<String, Object> parseParameterString(final String parameterString, final LogService logService) {
68-
return parseParameterString(parameterString, null, logService);
67+
public static Map<String, Object> parseParameterString(final String parameterString, final LogService log) {
68+
return parseParameterString(parameterString, null, log);
6969
}
7070

7171
/**
@@ -77,7 +77,7 @@ public static Map<String, Object> parseParameterString(final String parameterStr
7777
*
7878
* TODO reconcile with attribute parsing of {@link ScriptInfo}
7979
*/
80-
public static Map<String, Object> parseParameterString(final String parameterString, final ModuleInfo info, final LogService logService) {
80+
public static Map<String, Object> parseParameterString(final String parameterString, final ModuleInfo info, final LogService log) {
8181
final Map<String, Object> inputMap = new HashMap<String, Object>();
8282

8383
if (!parameterString.isEmpty()) {
@@ -93,8 +93,8 @@ public static Map<String, Object> parseParameterString(final String parameterStr
9393
else if (inputs != null && inputs.hasNext() && split.length == 1) {
9494
inputMap.put(inputs.next().getName(), split[0]);
9595
}
96-
else if (logService != null)
97-
logService.error("Parameters must be formatted as a comma-separated list of key=value pairs");
96+
else if (log != null)
97+
log.error("Parameters must be formatted as a comma-separated list of key=value pairs");
9898

9999
}
100100
}

src/main/java/org/scijava/script/ScriptLanguageIndex.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ public ScriptLanguageIndex() {
6868
/**
6969
* Instantiates an index of the available script languages.
7070
*
71-
* @param logService the log service for errors and warnings
71+
* @param log the log service for errors and warnings
7272
*/
73-
public ScriptLanguageIndex(final LogService logService) {
74-
log = logService;
73+
public ScriptLanguageIndex(final LogService log) {
74+
this.log = log;
7575
}
7676

7777
public boolean add(final ScriptEngineFactory factory, final boolean gently) {

src/main/java/org/scijava/script/console/RunScriptArgument.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public class RunScriptArgument extends AbstractConsoleArgument {
5555
private ScriptService scriptService;
5656

5757
@Parameter
58-
private LogService logService;
58+
private LogService log;
5959

6060
// -- Constructor --
6161

@@ -100,12 +100,12 @@ private void run(final String scriptToRun, final String paramString) {
100100

101101
final ScriptInfo info = scriptService.getScript(script);
102102

103-
final Map<String, Object> inputMap = ConsoleUtils.parseParameterString(paramString, info, logService);
103+
final Map<String, Object> inputMap = ConsoleUtils.parseParameterString(paramString, info, log);
104104

105105
try {
106106
scriptService.run(info, true, inputMap).get();
107107
} catch (final Exception exc) {
108-
logService.error(exc);
108+
log.error(exc);
109109
}
110110
}
111111

0 commit comments

Comments
 (0)