Package: UsageArgsInterpreter

UsageArgsInterpreter

name	instruction	branch	complexity	line	method
disableUsage()	M: 0 C: 4 100%	M: 0 C: 0 100%	M: 0 C: 1 100%	M: 0 C: 2 100%	M: 0 C: 1 100%
run(ApplicationArguments)	M: 0 C: 30 100%	M: 1 C: 5 83%	M: 1 C: 3 75%	M: 0 C: 6 100%	M: 0 C: 1 100%

Coverage

1: /*
2: * *********************************************************************************************************************
3: *
4: * SolidBlue 3: Data safety
5: * http://tidalwave.it/projects/solidblue3
6: *
7: * Copyright (C) 2023 - 2023 by Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *********************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
12: * the License. You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/solidblue3j-src
23: * git clone https://github.com/tidalwave-it/solidblue3j-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.datamanager.application.nogui.args;
28:
29: import jakarta.annotation.Nonnull;
30: import jakarta.inject.Provider;
31: import java.util.List;
32: import org.springframework.boot.ApplicationArguments;
33: import org.springframework.boot.ApplicationRunner;
34: import org.springframework.core.annotation.Order;
35: import org.springframework.stereotype.Component;
36: import it.tidalwave.datamanager.application.nogui.DataManagerPresentation;
37: import lombok.RequiredArgsConstructor;
38: import static org.springframework.core.Ordered.LOWEST_PRECEDENCE;
39:
40: /***********************************************************************************************************************
41: *
42: * The command line args interpreter that prints usage for all commands.
43: *
44: * @author Fabrizio Giudici
45: *
46: **********************************************************************************************************************/
47: @Component @Order(LOWEST_PRECEDENCE) @RequiredArgsConstructor
48: public class UsageArgsInterpreter implements ApplicationRunner
49: {
50: @Nonnull
51: private final DataManagerPresentation presentation;
52:
53: @Nonnull
54: private final Provider<List<UsageCapable>> usageCapables;
55:
56: private boolean printUsage = true;
57:
58: /*******************************************************************************************************************
59: * {@inheritDoc}
60: ******************************************************************************************************************/
61: @Override
62: public void run (@Nonnull final ApplicationArguments args)
63: {
64:• if (printUsage || args.containsOption("help"))
65: {
66:• if (args.getSourceArgs().length > 0)
67: {
68: presentation.notifyError("Syntax error: " + String.join(" ", args.getSourceArgs()));
69: }
70:
71: presentation.output("Usage:");
72: usageCapables.get().forEach(UsageCapable::printUsage);
73: }
74: }
75:
76: /*******************************************************************************************************************
77: *
78: * Disables usage printing.
79: *
80: ******************************************************************************************************************/
81: public void disableUsage()
82: {
83: printUsage = false;
84: }
85: }