- java.lang.Object
-
- javax.ws.rs.core.Variant
-
public class Variant extends Object
Abstraction for a resource representation variant. Contains information about media type, language and encoding of the resource representation.- Since:
- 1.0
- Author:
- Paul Sandoz, Marc Hadley
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
Variant.VariantListBuilder
A builder for a list of representation variants.
-
Constructor Summary
Constructors Constructor and Description Variant(MediaType mediaType, Locale language, String encoding)
Create a new instance of Variant.Variant(MediaType mediaType, String language, String encoding)
Create a new instance of Variant.Variant(MediaType mediaType, String language, String country, String encoding)
Create a new instance of Variant.Variant(MediaType mediaType, String language, String country, String languageVariant, String encoding)
Create a new instance of Variant.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static Variant.VariantListBuilder
encodings(String... encodings)
Create aVariant.VariantListBuilder
initialized with a set of supported encodings.boolean
equals(Object obj)
Compares obj to this variant to see if they are the same considering all property values.String
getEncoding()
Get the encoding of the variant.Locale
getLanguage()
Get the language of the variant.String
getLanguageString()
Get the string representation of the variant language, ornull
if no language has been set.MediaType
getMediaType()
Get the media type of the variant.int
hashCode()
Generate hash code from variant properties.static Variant.VariantListBuilder
languages(Locale... languages)
Create aVariant.VariantListBuilder
initialized with a set of supported languages.static Variant.VariantListBuilder
mediaTypes(MediaType... mediaTypes)
Create aVariant.VariantListBuilder
initialized with a set of supported media types.String
toString()
-
-
-
Constructor Detail
-
Variant
public Variant(MediaType mediaType, String language, String encoding)
Create a new instance of Variant.- Parameters:
mediaType
- the media type of the variant - may benull
.language
- the language of the variant (two-letter ISO-639 code); may benull
.encoding
- the content encoding of the variant - may benull
.- Throws:
IllegalArgumentException
- if all the parameters arenull
.- Since:
- 2.0
-
Variant
public Variant(MediaType mediaType, String language, String country, String encoding)
Create a new instance of Variant.- Parameters:
mediaType
- the media type of the variant - may benull
.language
- the language of the variant (two-letter ISO-639 code); may benull
.country
- uppercase two-letter ISO-3166 language code of the variant; may benull
providedlanguage
isnull
too.encoding
- the content encoding of the variant - may benull
.- Throws:
IllegalArgumentException
- if all the parameters arenull
.- Since:
- 2.0
-
Variant
public Variant(MediaType mediaType, String language, String country, String languageVariant, String encoding)
Create a new instance of Variant.- Parameters:
mediaType
- the media type of the variant - may benull
.language
- the language of the variant (two-letter ISO-639 code); may benull
.country
- uppercase two-letter ISO-3166 language code of the variant; may benull
providedlanguage
isnull
too.languageVariant
- vendor and browser specific language code of the variant (see alsoLocale
class description); may benull
providedlanguage
andcountry
arenull
too.encoding
- the content encoding of the variant - may benull
.- Throws:
IllegalArgumentException
- if all the parameters arenull
.- Since:
- 2.0
-
Variant
public Variant(MediaType mediaType, Locale language, String encoding)
Create a new instance of Variant.- Parameters:
mediaType
- the media type of the variant - may benull
.language
- the language of the variant - may benull
.encoding
- the content encoding of the variant - may benull
.- Throws:
IllegalArgumentException
- if all the parameters arenull
.
-
-
Method Detail
-
getLanguage
public Locale getLanguage()
Get the language of the variant.- Returns:
- the language or
null
if none set.
-
getLanguageString
public String getLanguageString()
Get the string representation of the variant language, ornull
if no language has been set.- Returns:
- the string representing variant language or
null
if none set. - Since:
- 2.0
-
getMediaType
public MediaType getMediaType()
Get the media type of the variant.- Returns:
- the media type or
null
if none set.
-
getEncoding
public String getEncoding()
Get the encoding of the variant.- Returns:
- the encoding or
null
if none set.
-
mediaTypes
public static Variant.VariantListBuilder mediaTypes(MediaType... mediaTypes)
Create aVariant.VariantListBuilder
initialized with a set of supported media types.- Parameters:
mediaTypes
- the available mediaTypes. If specific char-sets are supported they should be included as parameters of the respective media type.- Returns:
- the initialized builder.
- Throws:
IllegalArgumentException
- if mediaTypes is null or contains no elements.
-
languages
public static Variant.VariantListBuilder languages(Locale... languages)
Create aVariant.VariantListBuilder
initialized with a set of supported languages.- Parameters:
languages
- the available languages.- Returns:
- the initialized builder.
- Throws:
IllegalArgumentException
- if languages is null or contains no elements.
-
encodings
public static Variant.VariantListBuilder encodings(String... encodings)
Create aVariant.VariantListBuilder
initialized with a set of supported encodings.- Parameters:
encodings
- the available encodings.- Returns:
- the initialized builder.
- Throws:
IllegalArgumentException
- if encodings is null or contains no elements.
-
hashCode
public int hashCode()
Generate hash code from variant properties.
-
equals
public boolean equals(Object obj)
Compares obj to this variant to see if they are the same considering all property values.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 16:59:24 Cette version de la page est en cache (à la date du 21/08/2025 16:59:24) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 11/06/2005, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/ws/rs/core/Variant.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.