summaryrefslogtreecommitdiffstats
path: root/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineArgumentValue.java
blob: 732f88c8e094d7086f89189bbe9ee78453ebe1cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.auth.clieditor;

/**
 * This class represents an argument used on a command and its value.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class CommandLineArgumentValue {
    private final CommandLineArgument cliArgument;
    private boolean specified;
    private String value;

    /**
     * The Constructor creates an argument value for the given argument, has not been set, and has
     * no value.
     *
     * @param cliArgument the argument for which this object is a value
     */
    public CommandLineArgumentValue(final CommandLineArgument cliArgument) {
        this.cliArgument = cliArgument;
        specified = false;
        value = null;
    }

    /**
     * Gets the argument for which this object is a value.
     *
     * @return the argument for which this object is a value
     */
    public CommandLineArgument getCliArgument() {
        return cliArgument;
    }

    /**
     * Checks if the argument value is specified.
     *
     * @return true, if the argument value is specified
     */
    public boolean isSpecified() {
        return specified;
    }

    /**
     * Gets the argument value.
     *
     * @return the argument value
     */
    public String getValue() {
        return value;
    }

    /**
     * Sets the argument value.
     *
     * @param value the argument value
     */
    public void setValue(final String value) {
        this.value = value;
        specified = true;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public String toString() {
        return "CLIArgumentValue [cliArgument=" + cliArgument + ", specified=" + specified + ", value=" + value + "]";
    }
}