Package javax.ws.rs.core
Class Variant
java.lang.Object
javax.ws.rs.core.Variant
Abstraction for a resource representation variant.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
A builder for a list of representation variants. -
Field Summary
Fields -
Constructor Summary
Constructors -
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 variantGet the language of the variantGet the media type of the variantint
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()
-
Field Details
-
language
-
mediaType
-
encoding
-
-
Constructor Details
-
Variant
Create a new instance of Variant- Parameters:
mediaType
- the media type of the variant - may be nulllanguage
- the language of the variant - may be nullencoding
- the content encoding of the variant - may be null- Throws:
IllegalArgumentException
- if all three parameters are null
-
-
Method Details
-
getLanguage
Get the language of the variant- Returns:
- the language or null if none set
-
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 charsets are supported they should be included as parameters of the respective media type.- Returns:
- the initailized 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 initailized 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 initailized 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
-