Package javax.ws.rs.core
Class Variant
java.lang.Object
javax.ws.rs.core.Variant
Abstraction for a resource representation variant.
Contains information about media type, language and encoding of the resource representation.
- Since:
- 1.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
A builder for a list of representation variants. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Variant.VariantListBuilder
Create aVariant.VariantListBuilder
initialized with a set of supported encodings.boolean
Compares obj to this variant to see if they are the same considering all property values.Get the encoding of the variant.Get the language of the variant.Get the string representation of the variant language, ornull
if no language has been set.Get the media type of the variant.int
hashCode()
Generate hash code from variant properties.static Variant.VariantListBuilder
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.toString()
-
Constructor Details
-
Variant
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
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
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 Details
-
getLanguage
Get the language of the variant.- Returns:
- the language or
null
if none set.
-
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
Get the media type of the variant.- Returns:
- the media type or
null
if none set.
-
getEncoding
Get the encoding of the variant.- Returns:
- the encoding or
null
if none set.
-
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
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
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
Compares obj to this variant to see if they are the same considering all property values. -
toString
-