- 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.
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 18/08/2025
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-javaee-rf-javax/ws/rs/core/Variant.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor dieser Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.