LocaleType.java

  1. /*
  2.  *   Copyright (C) Christian Schulte <cs@schulte.it>, 2005-206
  3.  *   All rights reserved.
  4.  *
  5.  *   Redistribution and use in source and binary forms, with or without
  6.  *   modification, are permitted provided that the following conditions
  7.  *   are met:
  8.  *
  9.  *     o Redistributions of source code must retain the above copyright
  10.  *       notice, this list of conditions and the following disclaimer.
  11.  *
  12.  *     o Redistributions in binary form must reproduce the above copyright
  13.  *       notice, this list of conditions and the following disclaimer in
  14.  *       the documentation and/or other materials provided with the
  15.  *       distribution.
  16.  *
  17.  *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  18.  *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  19.  *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  20.  *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  *
  28.  *   $JOMC: LocaleType.java 5043 2015-05-27 07:03:39Z schulte $
  29.  *
  30.  */
  31. package org.jomc.ant.types;

  33. import org.apache.commons.lang.builder.ToStringBuilder;

  35. /**
  36.  * Datatype holding a {@code language}, {@code country} and {@code variant} property.
  37.  *
  38.  * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
  39.  * @version $JOMC: LocaleType.java 5043 2015-05-27 07:03:39Z schulte $
  40.  */
  41. public class LocaleType implements Cloneable
  42. {

  44.     /**
  45.      * The language.
  46.      */
  47.     private String language;

  49.     /**
  50.      * The country.
  51.      */
  52.     private String country;

  54.     /**
  55.      * The variant.
  56.      */
  57.     private String variant;

  59.     /**
  60.      * Creates a new {@code LocaleType} instance.
  61.      */
  62.     public LocaleType()
  63.     {
  64.         super();
  65.     }

  67.     /**
  68.      * Gets the value of the {@code language} property.
  69.      *
  70.      * @return The value of the {@code language} property.
  71.      *
  72.      * @see #setLanguage(java.lang.String)
  73.      */
  74.     public final String getLanguage()
  75.     {
  76.         return this.language;
  77.     }

  79.     /**
  80.      * Sets the value of the {@code language} property.
  81.      *
  82.      * @param value The new value of the {@code language} property or {@code null}.
  83.      *
  84.      * @see #getLanguage()
  85.      */
  86.     public final void setLanguage( final String value )
  87.     {
  88.         this.language = value;
  89.     }

  91.     /**
  92.      * Gets the value of the {@code country} property.
  93.      *
  94.      * @return The value of the {@code country} property.
  95.      *
  96.      * @see #setCountry(java.lang.String)
  97.      */
  98.     public final String getCountry()
  99.     {
  100.         return this.country;
  101.     }

  103.     /**
  104.      * Sets the value of the {@code country} property.
  105.      *
  106.      * @param value The new value of the {@code country} property or {@code null}.
  107.      *
  108.      * @see #getCountry()
  109.      */
  110.     public final void setCountry( final String value )
  111.     {
  112.         this.country = value;
  113.     }

  115.     /**
  116.      * Gets the value of the {@code variant} property.
  117.      *
  118.      * @return The value of the {@code variant} property.
  119.      *
  120.      * @see #setVariant(java.lang.String)
  121.      */
  122.     public final String getVariant()
  123.     {
  124.         return this.variant;
  125.     }

  127.     /**
  128.      * Sets the value of the {@code variant} property.
  129.      *
  130.      * @param value The new value of the {@code variant} property or {@code null}.
  131.      *
  132.      * @see #getVariant()
  133.      */
  134.     public final void setVariant( final String value )
  135.     {
  136.         this.variant = value;
  137.     }

  139.     /**
  140.      * Creates and returns a copy of this object.
  141.      *
  142.      * @return A copy of this object.
  143.      */
  144.     @Override
  145.     public LocaleType clone()
  146.     {
  147.         try
  148.         {
  149.             return (LocaleType) super.clone();
  150.         }
  151.         catch ( final CloneNotSupportedException e )
  152.         {
  153.             throw new AssertionError( e );
  154.         }
  155.     }

  157.     /**
  158.      * Creates and returns a string representation of the object.
  159.      *
  160.      * @return A string representation of the object.
  161.      */
  162.     @Override
  163.     public String toString()
  164.     {
  165.         return ToStringBuilder.reflectionToString( this );
  166.     }

  168. }
Created with JaCoCo 0.7.5.201505241946