- 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.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/ws/rs/core/Variant.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.