Class FormThemeFileResolutionParams

java.lang.Object

de.xima.fc.logic.form_theme.FormThemeFileResolutionParams

public final class FormThemeFileResolutionParams
extends Object

Parameters for resolving a file from a form theme, see FormThemeManager.

Since:

8.3.0

Author:

XIMA MEDIA GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FormThemeFileResolutionParams.Builder	A builder for creating file resolution params.

Method Summary

Modifier and Type	Method	Description
static FormThemeFileResolutionParams.Builder	builder(String resourceContext)	Creates a new builder for file resolution params.
Mandant	client()	Gets the client scope where to look for themes.
Predicate<? super String>	fileNameFilter()	Gets the filter for the files to include.
String	resourceContext()	The resource context in which the file is used.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

client

public Mandant client()

Gets the client scope where to look for themes. Required only if the theme is specific to a particular client.

Returns:

Client scope where to look for themes.

fileNameFilter

public Predicate<? super String> fileNameFilter()

Gets the filter for the files to include.

Returns:

The filter for the files to include.

resourceContext

public String resourceContext()

The resource context in which the file is used. See EFormThemeResourceContext for well-known contexts.

Returns:

The resource context from which to obtain the files.

builder

public static FormThemeFileResolutionParams.Builder builder(String resourceContext)

Creates a new builder for file resolution params. The resource context is required and must not be empty.

Parameters:

resourceContext - The resource context in which the file is used. See EFormThemeResourceContext for well-known contexts.

Returns:

A new builder for creating a FormThemeFileResolutionParams instance.