Class FileSearchOptions

java.lang.Object

de.xima.fc.workflow.FileSearchOptions

All Implemented Interfaces:

IFileSearchOptions, Serializable

public final class FileSearchOptions
extends Object
implements IFileSearchOptions, Serializable

Default POJO implementation of IFileSearchOptions.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FileSearchOptions.Builder	A builder for file search options.

Constructor Summary

Constructors

Constructor	Description
FileSearchOptions(String defaultResourceFileName)	Deprecated. Use builder() instead.
FileSearchOptions(String defaultResourceFileName, Iterable<String> allowedFileExtensions)	Deprecated. Use builder() instead.

Method Summary

Modifier and Type	Method	Description
static FileSearchOptions.Builder	builder()	Creates a new builder for file search options.
Set<String>	getAllowedContentTypes()	List of allowed content types.
Set<String>	getAllowedFileExtensions()	List of allowed file extensions.
String	getDefaultResourceFileName()	File name that is used for external network resources.

Methods inherited from class Object

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

Constructor Details

FileSearchOptions

@Deprecated
public FileSearchOptions(String defaultResourceFileName)

Deprecated.

Use builder() instead.

A new POJO with the given data an no getAllowedFileExtensions().

Parameters:

defaultResourceFileName - The value for getDefaultResourceFileName().

FileSearchOptions

@Deprecated
public FileSearchOptions(String defaultResourceFileName,
 Iterable<String> allowedFileExtensions)

Deprecated.

Use builder() instead.

A new POJO with the given data.

Parameters:

defaultResourceFileName - The value for getDefaultResourceFileName().

allowedFileExtensions - The value for getAllowedFileExtensions().

Method Details

getAllowedContentTypes

public Set<String> getAllowedContentTypes()

Description copied from interface: IFileSearchOptions

List of allowed content types. Only files with one of these content types are returned. When null or empty, no restriction is applied.

Specified by:

getAllowedContentTypes in interface IFileSearchOptions

Returns:

Set of allowed content types.

getAllowedFileExtensions

public Set<String> getAllowedFileExtensions()

Description copied from interface: IFileSearchOptions

List of allowed file extensions. Only files with one of these extensions are returned. When null or empty, no restriction is applied.

Specified by:

getAllowedFileExtensions in interface IFileSearchOptions

Returns:

Set of allowed file extensions.

getDefaultResourceFileName

public String getDefaultResourceFileName()

Description copied from interface: IFileSearchOptions

File name that is used for external network resources. If not given, a file name is derived from the URL.

Specified by:

getDefaultResourceFileName in interface IFileSearchOptions

Returns:

File name that is used for external network resources.

builder

public static FileSearchOptions.Builder builder()

Creates a new builder for file search options.

Returns:

A new builder.

Since:

8.2.0