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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/**
* \cond LICENSE
* Arara -- the cool TeX automation tool
* Copyright (c) 2012, Paulo Roberto Massa Cereda
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the project's author nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
* WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* \endcond
*
* PlainAraraRuleConfig: This class provides the model for representing a plain
* Arara rule configuration based on the YAML files. It's a plain old Java
* object.
*/
// package definition
package com.github.arara.model;
// needed imports
import com.github.arara.utils.AraraUtils;
import java.util.ArrayList;
import java.util.List;
/**
* Provides the model for representing a plain Arara rule configuration based on
* the YAML files. This class will be used to map YAML rules into Java objects.
*
* @author Paulo Roberto Massa Cereda
* @version 3.0a
* @since 1.0
*/
public class AraraRuleConfig {
// the rule identifier
private String identifier;
// the rule name
private String name;
// the rule command
private String command;
// the rule commands
private List<String> commands;
// the arguments list
private List<AraraRuleArgument> arguments;
public List<String> getCommands() {
return commands;
}
/**
* Setter for the rule commands.
*
* @param commands A list containing the rule commands.
*/
public void setCommands(List<String> commands) {
this.commands = commands;
// for every entry
for (int i = 0; i < commands.size(); i++) {
// remove keyword and reinsert into the list
String currentCommand = AraraUtils.removeKeyword(commands.get(i));
commands.set(i, currentCommand);
}
}
/**
* Getter for the rule identifier.
*
* @return The rule identifier.
*/
public String getIdentifier() {
// return it
return identifier;
}
/**
* Setter for the rule identifier.
*
* @param identifier The rule identifier.
*/
public void setIdentifier(String identifier) {
// set the identifier
this.identifier = identifier;
}
/**
* Getter for the rule name.
*
* @return The rule name.
*/
public String getName() {
// return it
return name;
}
/**
* Setter for the rule name.
*
* @param name The rule name.
*/
public void setName(String name) {
// set the rule name
this.name = name;
}
/**
* Getter for the rule command.
*
* @return The rule command.
*/
public String getCommand() {
// return it
return command;
}
/**
* Setter for the rule command.
*
* @param command The rule command.
*/
public void setCommand(String command) {
// set the command
this.command = AraraUtils.removeKeyword(command);
}
/**
* Getter for the arguments list.
*
* @return The arguments list.
*/
public List<AraraRuleArgument> getArguments() {
// return the list
return arguments;
}
/**
* Setter for the arguments list.
*
* @param arguments The arguments list.
*/
public void setArguments(List<AraraRuleArgument> arguments) {
// set the list
this.arguments = arguments;
}
/**
* Returns a list containing all argument identifiers.
*
* @return A list containing all argument identifiers.
*/
public List<String> getIdentifiersList() {
// create a new list
List<String> result = new ArrayList<String>();
// for every argument
for (AraraRuleArgument argument : getArguments()) {
// add identifier
result.add(argument.getIdentifier());
}
// return list
return result;
}
/**
* Returns the forbidden identifier, if any.
*
* @return The forbidden identifier, if any.
*/
public String checkForForbiddenIdentifiers() {
// for every argument
for (AraraRuleArgument argument : getArguments()) {
// get the current argument value
String value = argument.getIdentifier().toLowerCase();
// check if it's a forbidden argument identifier
if ((value.equals("file")) || (value.equals("files")) || (value.equals("item")) || (value.equals("items"))) {
// return the value
return value;
}
}
// nothing wrong was found
return null;
}
}
|