summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/support/arara/src/main/java/com/github/arara/model/AraraDirective.java
blob: 5dc8842456b6d23625e8772e48cb33f5f681f64f (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
/**
 * \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
 *
 * AraraDirective: This class provides the model for representing the arara
 * directives found in the source file. It's a plain old Java object.
 */
// package definition
package com.github.arara.model;

// needed imports
import java.util.Map;

/**
 * Provides the model for representing the arara directives found in the source
 * file.
 *
 * @author Paulo Roberto Massa Cereda
 * @version 3.0a
 * @since 1.0
 */
public class AraraDirective {

    // the directive name
    private String name;
    // the configuration
    private Map config;
    // the line number
    private int lineNumber = 0;

    /**
     * Constructor.
     *
     * @param name The directive name.
     * @param config The configuration.
     */
    public AraraDirective(String name, Map config) {

        // set the name
        this.name = name;

        // set the configuration
        this.config = config;
    }

    /**
     * Constructor.
     */
    public AraraDirective() {
    }

    /**
     * Getter for configuration.
     *
     * @return The configuration.
     */
    public Map getConfig() {

        // return it
        return config;
    }

    /**
     * Setter for configuration.
     *
     * @param config The configuration.
     */
    public void setConfig(Map config) {

        // set the configuration
        this.config = config;
    }

    /**
     * Getter for the directive name.
     *
     * @return The directive name.
     */
    public String getName() {

        // return it
        return name;
    }

    /**
     * Setter for the directive name.
     *
     * @param name The directive name.
     */
    public void setName(String name) {

        // set it
        this.name = name;
    }

    /**
     * Getter for the line number.
     *
     * @return The line number.
     */
    public int getLineNumber() {

        // return it
        return lineNumber;
    }

    /**
     * Setter for the line number.
     *
     * @param lineNumber The line number.
     */
    public void setLineNumber(int lineNumber) {

        // set it
        this.lineNumber = lineNumber;
    }
}