summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/support/arara/src/main/java/com/github/arara/model/AraraLanguage.java
blob: b04e9850236b19ea8af69ab0e7776bde213ef5a3 (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
/**
 * \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
 * 
 * AraraLanguage: This class holds the data model for the arara language
 * specification.
 */
// package definition.
package com.github.arara.model;

// needed import
import java.util.Locale;

/**
 * Holds the data model for the arara language specification.
 *
 * @author Paulo Roberto Massa Cereda
 * @version 3.0a
 * @since 3.0
 */
public class AraraLanguage {

    // language name
    private String name;
    // language code
    private String code;
    // language locale
    private Locale locale;

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

    /**
     * Setter for the language name.
     *
     * @param name The language name.
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * Getter for the language code.
     *
     * @return The language code.
     */
    public String getCode() {
        return code;
    }

    /**
     * Setter for the language code.
     *
     * @param code The language code.
     */
    public void setCode(String code) {
        this.code = code;
    }

    /**
     * Getter for the language locale.
     *
     * @return The language locale.
     */
    public Locale getLocale() {
        return locale;
    }

    /**
     * Setter for the language locale.
     *
     * @param locale The language locale.
     */
    public void setLocale(Locale locale) {
        this.locale = locale;
    }

    /**
     * Constructor.
     *
     * @param name The language name.
     * @param code The language code.
     * @param locale The language locale.
     */
    public AraraLanguage(String name, String code, Locale locale) {
        this.name = name;
        this.code = code;
        this.locale = locale;
    }

    /**
     * Returns a string representation of the object.
     *
     * @return The string representation of the object.
     */
    @Override
    public String toString() {
        return name.concat(" [").concat(code).concat("]");
    }
}