Class LanguageTag


  • public final class LanguageTag
    extends java.lang.Object
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  LanguageTag.Extension  
    • Constructor Summary

      Constructors 
      Constructor Description
      LanguageTag()  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addExtension​(LanguageTag.Extension extension)  
      protected void addLanguageExtension​(java.lang.String languageExtension)  
      protected void addPrivateUse​(java.lang.String privateTag)  
      protected void addVariant​(java.lang.String variant)  
      static LanguageTag create​(java.lang.String languageTag)
      Creates a language tag by parsing the given string as defined by RFC 5646.
      boolean equals​(java.lang.Object obj)  
      java.util.Collection<LanguageTag.Extension> getExtensions()
      Collection of extension sub-tags.
      java.lang.String getLanguage()
      Language as shortest ISO 639 code or reserved code for future use or registered language subtag code.
      java.util.Collection<java.lang.String> getLanguageExtensions()
      Collection of ISO 639 codes.
      java.util.Collection<java.lang.String> getPrivateUse()
      Collection of private sub-tags.
      java.lang.String getRegion()
      Region as ISO 3166-1 or UN M.49 code
      java.lang.String getScript()
      Script as ISO 15924 code.
      java.util.Collection<java.lang.String> getVariants()
      Collection of registered variant codes.
      int hashCode()  
      static boolean isWellFormed​(java.lang.String languageTag)
      Language tags are used to help identify languages and are defined by RFC 5646
      protected void setLanguage​(java.lang.String language)  
      protected void setRegion​(java.lang.String region)  
      protected void setScript​(java.lang.String script)  
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • language

        private java.lang.String language
      • languageExtensions

        private java.util.Collection<java.lang.String> languageExtensions
      • script

        private java.lang.String script
      • region

        private java.lang.String region
      • variants

        private java.util.Collection<java.lang.String> variants
      • privateUse

        private java.util.Collection<java.lang.String> privateUse
    • Constructor Detail

      • LanguageTag

        LanguageTag()
    • Method Detail

      • isWellFormed

        public static boolean isWellFormed​(java.lang.String languageTag)
        Language tags are used to help identify languages and are defined by RFC 5646
        Parameters:
        languageTag - to check
        Returns:
        true if the provided value is well-formed language tag
        See Also:
        RFC 5643 - 2.1 Syntax
      • create

        public static LanguageTag create​(java.lang.String languageTag)
        Creates a language tag by parsing the given string as defined by RFC 5646.
        Parameters:
        languageTag - the string to be parsed into a language tag
        Returns:
        The new language tag
        Throws:
        java.lang.IllegalArgumentException - if the given string is not well-formed
      • getLanguage

        public java.lang.String getLanguage()
        Language as shortest ISO 639 code or reserved code for future use or registered language subtag code.
        Returns:
        the language code
      • getLanguageExtensions

        public java.util.Collection<java.lang.String> getLanguageExtensions()
        Collection of ISO 639 codes.
        Returns:
        the extension codes
      • getScript

        public java.lang.String getScript()
        Script as ISO 15924 code.
        Returns:
        the script name code
      • getRegion

        public java.lang.String getRegion()
        Region as ISO 3166-1 or UN M.49 code
        Returns:
        the region code
      • getVariants

        public java.util.Collection<java.lang.String> getVariants()
        Collection of registered variant codes.
        Returns:
        the variant codes
      • getExtensions

        public java.util.Collection<LanguageTag.Extension> getExtensions()
        Collection of extension sub-tags.
        Returns:
        a collection of sub-tags
      • getPrivateUse

        public java.util.Collection<java.lang.String> getPrivateUse()
        Collection of private sub-tags.
        Returns:
        a collection of private sub-tags
      • setLanguage

        protected void setLanguage​(java.lang.String language)
      • addLanguageExtension

        protected void addLanguageExtension​(java.lang.String languageExtension)
      • setScript

        protected void setScript​(java.lang.String script)
      • setRegion

        protected void setRegion​(java.lang.String region)
      • addVariant

        protected void addVariant​(java.lang.String variant)
      • addPrivateUse

        protected void addPrivateUse​(java.lang.String privateTag)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object