Package de.espirit.firstspirit.client.plugin.dataaccess.aspects

Interface UrlGenerationContext.Builder

Enclosing interface:

UrlGenerationContext

@NonExtendable
public static interface UrlGenerationContext.Builder

Builder for an UrlGenerationContext.

Since:

5.2.200303

Method Summary

Modifier and Type	Method	Description
@NotNull UrlGenerationContext.Builder	attribute(@NotNull String name, @Nullable Object value)	Configures an attribute to be available in the generation context.
@NotNull UrlGenerationContext	create()	Creates a new UrlGenerationContext instance based on the given configuration.
@NotNull UrlGenerationContext.Builder	from(@NotNull GenerationContext context)	The GenerationContext to extract the context information from, which consists of: The UrlCreator configured in the given generation context The UrlCreatorProvider available in the given generation context The contextual Language Whether or not the release version is used
@NotNull UrlGenerationContext.Builder	from(@NotNull JsonGenerationContext context)	The JsonGenerationContext to extract the context information from, which consists of: The UrlCreator configured in the generation context The UrlCreatorProvider available in the generation context The contextual Language Whether or not the release version is used The current attributes available in the given JSON generation context
@NotNull UrlGenerationContext.Builder	language(@Nullable Language language)	Configures the contextual Language when requesting the URL.
@NotNull UrlGenerationContext.Builder	release(boolean release)	Indicates whether or not the URL is requested in the context of a release version.
@NotNull UrlGenerationContext.Builder	urlCreator(@Nullable UrlCreator urlCreator)	Configures the url creator to be used in the current generation context.
@NotNull UrlGenerationContext.Builder	urlCreatorProvider(@Nullable UrlCreatorProvider urlCreatorProvider)	Configures the provider of url creators in the current generation context.

Method Details

from

@NotNull
@NotNull UrlGenerationContext.Builder from(@NotNull
 @NotNull GenerationContext context)

The GenerationContext to extract the context information from, which consists of:

• The UrlCreator configured in the given generation context
• The UrlCreatorProvider available in the given generation context
• The contextual Language
• Whether or not the release version is used

Parameters:

context - The GenerationContext in which the URLs will be requested.

Returns:

This builder instance.

Since:

5.2.200303

from

@NotNull
@NotNull UrlGenerationContext.Builder from(@NotNull
 @NotNull JsonGenerationContext context)

The JsonGenerationContext to extract the context information from, which consists of:

• The UrlCreator configured in the generation context
• The UrlCreatorProvider available in the generation context
• The contextual Language
• Whether or not the release version is used
• The current attributes available in the given JSON generation context

Parameters:

context - The JsonGenerationContext in which the URLs will be requested.

Returns:

This builder instance.

Since:

5.2.200303

urlCreator

@NotNull
@NotNull UrlGenerationContext.Builder urlCreator(@Nullable
 @Nullable UrlCreator urlCreator)

Configures the url creator to be used in the current generation context.

Parameters:

urlCreator - The url creator to be used.

Returns:

This builder instance.

Since:

5.2.200303

See Also:

• from(JsonGenerationContext)
• from(GenerationContext)
• urlCreatorProvider(UrlCreatorProvider)

urlCreatorProvider

@NotNull
@NotNull UrlGenerationContext.Builder urlCreatorProvider(@Nullable
 @Nullable UrlCreatorProvider urlCreatorProvider)

Configures the provider of url creators in the current generation context. The given UrlCreatorProvider will also be used to provider the UrlCreator and release version flag if necessary.

Parameters:

urlCreatorProvider - The url creator provider to be used.

Returns:

This builder instance.

Since:

5.2.200303

See Also:

• from(JsonGenerationContext)
• from(GenerationContext)

attribute

@NotNull
@NotNull UrlGenerationContext.Builder attribute(@NotNull
 @NotNull String name,
 @Nullable
 @Nullable Object value)

Configures an attribute to be available in the generation context.

Parameters:

name - the name of the attribute.

value - the value of the attribute.

Returns:

This builder instance.

Since:

5.2.200303

See Also:

• from(JsonGenerationContext)

release

@NotNull
@NotNull UrlGenerationContext.Builder release(boolean release)

Indicates whether or not the URL is requested in the context of a release version.

Parameters:

release - true this context is based on a release version

Returns:

This builder instance.

Since:

5.2.200303

See Also:

• from(JsonGenerationContext)
• from(GenerationContext)
• urlCreatorProvider(UrlCreatorProvider)

language

@NotNull
@NotNull UrlGenerationContext.Builder language(@Nullable
 @Nullable Language language)

Configures the contextual Language when requesting the URL.

Parameters:

language - The contextual Language.

Returns:

This builder instance.

Since:

5.2.200303

See Also:

• from(JsonGenerationContext)
• from(GenerationContext)

create

@NotNull
@NotNull UrlGenerationContext create()

Creates a new UrlGenerationContext instance based on the given configuration.

Returns:

The new context instance.

Since:

5.2.200303