blob: 5bc6d79e2981b18e6daac4ee8600dc812bb21625 (
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
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.tools.ant.types;
import java.util.Vector;
import org.apache.tools.ant.BuildException;
/**
* Wrapper for environment variables.
*
*/
public class Environment {
// CheckStyle:VisibilityModifier OFF - bc
/**
* a vector of type Environment.Variable
* @see Variable
*/
protected Vector<Variable> variables;
// CheckStyle:VisibilityModifier ON
/**
* representation of a single env value
*/
public static class Variable {
/**
* env key and value pair; everything gets expanded to a string
* during assignment
*/
private String key, value;
/**
* Constructor for variable
*
*/
public Variable() {
super();
}
/**
* set the key
* @param key string
*/
public void setKey(String key) {
this.key = key;
}
/**
* set the value
* @param value string value
*/
public void setValue(String value) {
this.value = value;
}
/**
* key accessor
* @return key
*/
public String getKey() {
return this.key;
}
/**
* value accessor
* @return value
*/
public String getValue() {
return this.value;
}
/**
* stringify path and assign to the value.
* The value will contain all path elements separated by the appropriate
* separator
* @param path path
*/
public void setPath(Path path) {
this.value = path.toString();
}
/**
* get the absolute path of a file and assign it to the value
* @param file file to use as the value
*/
public void setFile(java.io.File file) {
this.value = file.getAbsolutePath();
}
/**
* get the assignment string
* This is not ready for insertion into a property file without following
* the escaping rules of the properties class.
* @return a string of the form key=value.
* @throws BuildException if key or value are unassigned
*/
public String getContent() throws BuildException {
validate();
StringBuffer sb = new StringBuffer(key.trim());
sb.append("=").append(value.trim());
return sb.toString();
}
/**
* checks whether all required attributes have been specified.
* @throws BuildException if key or value are unassigned
*/
public void validate() {
if (key == null || value == null) {
throw new BuildException("key and value must be specified "
+ "for environment variables.");
}
}
}
/**
* constructor
*/
public Environment() {
variables = new Vector<Variable>();
}
/**
* add a variable.
* Validity checking is <i>not</i> performed at this point. Duplicates
* are not caught either.
* @param var new variable.
*/
public void addVariable(Variable var) {
variables.addElement(var);
}
/**
* get the variable list as an array
* @return array of key=value assignment strings
* @throws BuildException if any variable is misconfigured
*/
public String[] getVariables() throws BuildException {
if (variables.size() == 0) {
return null;
}
String[] result = new String[variables.size()];
for (int i = 0; i < result.length; i++) {
result[i] = ((Variable) variables.elementAt(i)).getContent();
}
return result;
}
/**
* Get the raw vector of variables. This is not a clone.
* @return a potentially empty (but never null) vector of elements of type
* Variable
* @since Ant 1.7
*/
public Vector<Variable> getVariablesVector() {
return variables;
}
}
|
