Modifier | Constructor and Description |
---|---|
protected |
VariantListBuilder()
Protected constructor, use the static
newInstance
method to obtain an instance. |
Modifier and Type | Method and Description |
---|---|
abstract Variant.VariantListBuilder |
add()
Add the current combination of metadata to the list of supported variants,
after this method is called the current combination of metadata is emptied.
|
abstract List<Variant> |
build()
Add the current combination of metadata to the list of supported variants
(provided the current combination of metadata is not empty) and
build a list of representation variants from the current state of
the builder.
|
abstract Variant.VariantListBuilder |
encodings(String... encodings)
Set the encoding(s) for this variant.
|
abstract Variant.VariantListBuilder |
languages(Locale... languages)
Set the language(s) for this variant.
|
abstract Variant.VariantListBuilder |
mediaTypes(MediaType... mediaTypes)
Set the media type(s) for this variant.
|
static Variant.VariantListBuilder |
newInstance()
Create a new builder instance.
|
protected VariantListBuilder()
newInstance
method to obtain an instance.public static Variant.VariantListBuilder newInstance()
public abstract List<Variant> build()
public abstract Variant.VariantListBuilder add()
If more than one value is supplied for one or more of the variant properties
then a variant will be generated for each possible combination. E.g.
in the following list
would have five (4 + 1) members:
Listlist = VariantListBuilder.newInstance() .languages(Locale.ENGLISH, Locale.FRENCH).encodings("zip", "identity").add() .languages(Locale.GERMAN).mediaTypes(MediaType.TEXT_PLAIN_TYPE).add() .build()
Note that it is not necessary to call the add()
method immediately before
the build method is called. E.g. the resulting list produced in the example above
would be identical to the list produced by the following code:
Listlist = VariantListBuilder.newInstance() .languages(Locale.ENGLISH, Locale.FRENCH).encodings("zip", "identity").add() .languages(Locale.GERMAN).mediaTypes(MediaType.TEXT_PLAIN_TYPE) .build()
IllegalStateException
- if there is not at least one
mediaType, language or encoding set for the current variant.public abstract Variant.VariantListBuilder languages(Locale... languages)
languages
- the available languages.public abstract Variant.VariantListBuilder encodings(String... encodings)
encodings
- the available encodings.public abstract Variant.VariantListBuilder mediaTypes(MediaType... mediaTypes)
mediaTypes
- the available mediaTypes. If specific charsets
are supported they should be included as parameters of the respective
media type.Copyright © 1996-2017, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.