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
|
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.property;
import java.util.Locale;
/**
* This interface represents a property descriptor. A descriptor
* includes information that describe a property.
*
* @version $Revision$, $Date$
*/
public class Descriptor implements IDescriptor {
protected String mSyntax = null;
protected String mConstraint = null;
protected String mDescription = null;
protected String mDef = null;
/**
* Constructs a descriptor.
*
* @param syntax syntax
* @param constraint constraint
* @param defValue default value
* @param description description
*/
public Descriptor(String syntax, String constraint, String defValue, String description) {
mSyntax = syntax;
mConstraint = constraint;
mDef = defValue;
mDescription = description;
}
/**
* Returns the syntax of the property.
*
* @return syntax
*/
public String getSyntax() {
return mSyntax;
}
/**
* Returns the default value of the property.
*
* @return default value
*/
public String getDefaultValue() {
return mDef;
}
/**
* Constraint for the given syntax. For example,
* <p>
* - number(1-5): 1-5 is the constraint, and it indicates
* that the number must be in the range of 1 to 5.
* <p>
* - choice(cert,crl): cert,crl is the constraint
* for choice
* <p>
* If null, no constraint shall be enforced.
* <p>
* @return constraint
*/
public String getConstraint() {
return mConstraint;
}
/**
* Retrieves the description of the property.
* @param locale user locale
* @return description
*/
public String getDescription(Locale locale) {
return mDescription;
}
}
|
