James Moger
2011-10-21 b75734f0600c333d70a3659af82be54caf3cfd3e
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/*
 * Copyright 2011 gitblit.com.
 *
 * 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.
 */
package com.gitblit.models;
 
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
 
import com.gitblit.utils.StringUtils;
 
/**
 * SettingModel represents a setting and all its metadata: name, current value,
 * default value, description, and directives.
 * 
 * @author James Moger
 */
public class SettingModel implements Serializable {
 
    public static final String SPACE_DELIMITED = "SPACE-DELIMITED";
 
    public static final String CASE_SENSITIVE = "CASE-SENSITIVE";
 
    public static final String RESTART_REQUIRED = "RESTART REQUIRED";
 
    public static final String SINCE = "SINCE";
 
    public String name;
    public volatile String currentValue;
    public String defaultValue;
    public String description;
    public String since;
    public boolean caseSensitive;
    public boolean restartRequired;
    public boolean spaceDelimited;
 
    private static final long serialVersionUID = 1L;
 
    public SettingModel() {
    }
 
    /**
     * Returns true if the current value is the default value.
     * 
     * @return true if current value is the default value
     */
    public boolean isDefaultValue() {
        return (currentValue != null && currentValue.equals(defaultValue))
                || currentValue.trim().length() == 0;
    }
 
    /**
     * Returns the boolean value for the currentValue. If the currentValue can
     * not be interpreted as a boolean, the defaultValue is returned.
     * 
     * @param defaultValue
     * @return key value or defaultValue
     */
    public boolean getBoolean(boolean defaultValue) {
        if (!StringUtils.isEmpty(currentValue)) {
            return Boolean.parseBoolean(currentValue.trim());
        }
        return defaultValue;
    }
 
    /**
     * Returns the integer value for the currentValue. If the currentValue can
     * not be interpreted as an integer, the defaultValue is returned.
     * 
     * @param defaultValue
     * @return key value or defaultValue
     */
    public int getInteger(int defaultValue) {
        try {
            if (!StringUtils.isEmpty(currentValue)) {
                return Integer.parseInt(currentValue.trim());
            }
        } catch (NumberFormatException e) {
        }
        return defaultValue;
    }
 
    /**
     * Returns the char value for currentValue. If the currentValue can not be
     * interpreted as a char, the defaultValue is returned.
     * 
     * @param defaultValue
     * @return key value or defaultValue
     */
    public char getChar(char defaultValue) {
        if (!StringUtils.isEmpty(currentValue)) {
            return currentValue.trim().charAt(0);
        }
        return defaultValue;
    }
 
    /**
     * Returns the string value for currentValue. If the currentValue is null,
     * the defaultValue is returned.
     * 
     * @param defaultValue
     * @return key value or defaultValue
     */
    public String getString(String defaultValue) {
        if (currentValue != null) {
            return currentValue.trim();
        }
        return defaultValue;
    }
 
    /**
     * Returns a list of space-separated strings from the specified key.
     * 
     * @return list of strings
     */
    public List<String> getStrings() {
        return getStrings(" ");
    }
 
    /**
     * Returns a list of strings from the currentValue using the specified
     * string separator.
     * 
     * @param separator
     * @return list of strings
     */
    public List<String> getStrings(String separator) {
        List<String> strings = new ArrayList<String>();
        strings = StringUtils.getStringsFromValue(currentValue, separator);
        return strings;
    }
}