1 /**
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.creadur.whisker.app;
20
21 /**
22 * An operation to be performed by Whisker.
23 */
24 public enum Act {
25
26 /** Generate legal documentation. */
27 GENERATE(false),
28 /** Validate contents against meta-data. */
29 AUDIT(true),
30 /** Writes report on directories. */
31 REPORT(true),
32 /** Outlines the directory structure. */
33 SKELETON(true);
34
35 /** Is the source required to perform this operation? */
36 private final boolean isSourceRequired;
37
38 /**
39 * Constructs an instance.
40 * @param isSourceRequired true when source is require,
41 * false otherwise
42 */
43 private Act(final boolean isSourceRequired) {
44 this.isSourceRequired = isSourceRequired;
45 }
46
47 /**
48 * Is source required for this operation?
49 * @return true when the source is required,
50 * false otherwise
51 */
52 public boolean isSourceRequired() {
53 return isSourceRequired;
54 }
55 }