001/*
002 *   Copyright (C) 2005 Christian Schulte <cs@schulte.it>
003 *   All rights reserved.
004 *
005 *   Redistribution and use in source and binary forms, with or without
006 *   modification, are permitted provided that the following conditions
007 *   are met:
008 *
009 *     o Redistributions of source code must retain the above copyright
010 *       notice, this list of conditions and the following disclaimer.
011 *
012 *     o Redistributions in binary form must reproduce the above copyright
013 *       notice, this list of conditions and the following disclaimer in
014 *       the documentation and/or other materials provided with the
015 *       distribution.
016 *
017 *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
018 *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
019 *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
020 *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
021 *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
022 *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
023 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
024 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
025 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
026 *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027 *
028 *   $JOMC: LocaleType.java 5135 2016-04-08 13:53:07Z schulte $
029 *
030 */
031package org.jomc.mojo;
032
033import org.apache.commons.lang.builder.ToStringBuilder;
034
035/**
036 * Datatype holding a {@code language}, {@code country} and {@code variant} property.
037 *
038 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
039 * @version $JOMC: LocaleType.java 5135 2016-04-08 13:53:07Z schulte $
040 * @since 1.2
041 */
042public class LocaleType implements Cloneable
043{
044
045    /**
046     * The language.
047     */
048    private String language;
049
050    /**
051     * The country.
052     */
053    private String country;
054
055    /**
056     * The variant.
057     */
058    private String variant;
059
060    /**
061     * Creates a new {@code LocaleType} instance.
062     */
063    public LocaleType()
064    {
065        super();
066    }
067
068    /**
069     * Gets the value of the {@code language} property.
070     *
071     * @return The value of the {@code language} property.
072     *
073     * @see #setLanguage(java.lang.String)
074     */
075    public final String getLanguage()
076    {
077        return this.language;
078    }
079
080    /**
081     * Sets the value of the {@code language} property.
082     *
083     * @param value The new value of the {@code language} property or {@code null}.
084     *
085     * @see #getLanguage()
086     */
087    public final void setLanguage( final String value )
088    {
089        this.language = value;
090    }
091
092    /**
093     * Gets the value of the {@code country} property.
094     *
095     * @return The value of the {@code country} property.
096     *
097     * @see #setCountry(java.lang.String)
098     */
099    public final String getCountry()
100    {
101        return this.country;
102    }
103
104    /**
105     * Sets the value of the {@code country} property.
106     *
107     * @param value The new value of the {@code country} property or {@code null}.
108     *
109     * @see #getCountry()
110     */
111    public final void setCountry( final String value )
112    {
113        this.country = value;
114    }
115
116    /**
117     * Gets the value of the {@code variant} property.
118     *
119     * @return The value of the {@code variant} property.
120     *
121     * @see #setVariant(java.lang.String)
122     */
123    public final String getVariant()
124    {
125        return this.variant;
126    }
127
128    /**
129     * Sets the value of the {@code variant} property.
130     *
131     * @param value The new value of the {@code variant} property or {@code null}.
132     *
133     * @see #getVariant()
134     */
135    public final void setVariant( final String value )
136    {
137        this.variant = value;
138    }
139
140    /**
141     * Creates and returns a copy of this object.
142     *
143     * @return A copy of this object.
144     */
145    @Override
146    public LocaleType clone()
147    {
148        try
149        {
150            return (LocaleType) super.clone();
151        }
152        catch ( final CloneNotSupportedException e )
153        {
154            throw new AssertionError( e );
155        }
156    }
157
158    /**
159     * Creates and returns a string representation of the object.
160     *
161     * @return A string representation of the object.
162     */
163    @Override
164    public String toString()
165    {
166        return ToStringBuilder.reflectionToString( this );
167    }
168
169}