Package de.xima.fc.workflow

Class FileListDescriptor

java.lang.Object

de.xima.fc.workflow.FileListDescriptor

All Implemented Interfaces:

IFileListDescriptor, Serializable

public final class FileListDescriptor
extends Object
implements IFileListDescriptor

Basic POJO implementation of IFileListDescriptor with a builder.

Since:

8.2.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileListDescriptor.Builder	Builder for FileListDescriptor.

Method Summary

Modifier and Type	Method	Description
static IFileListDescriptor	any()	Returns an IFileListDescriptor that allows any file type and any number of files.
IFileListBuilder	builder()	Creates a new builder for configuring a file list conforming to this descriptor.
static IFileListDescriptor	empty()	Returns an empty IFileListDescriptor that does not allow any files.
static FileListDescriptor.Builder	fileListDescriptorBuilder()	Creates a new builder for FileListDescriptor.
Set<String>	getContentTypes()	The content types of the files that might be contained in the list of files.
String	getDescription()	Gets the description for the file.
int	getMaxFileCount()	The maximum number of files that will be contained in the list of files.
int	getMinFileCount()	The minimum number of files that are contained in the list of files.
IFileListDescriptor	intersect(IFileListDescriptor other)	Intersects this file list descriptor with another file list descriptor.
boolean	isDescriptionHtml()	Whether the IFileListDescriptor.getDescription() is an HTML string (make sure it's valid and properly escaped!).
boolean	isDescriptionI18nKey()	Whether the IFileListDescriptor.getDescription() is an I18N key that needs to be looked up in a resource bundle.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IFileListDescriptor

allowsAnyFiles

Method Detail

builder

public IFileListBuilder builder()

Description copied from interface: IFileListDescriptor

Creates a new builder for configuring a file list conforming to this descriptor.

Specified by:

builder in interface IFileListDescriptor

Returns:

A new builder for configuring a file list conforming to this descriptor.

getContentTypes

public Set<String> getContentTypes()

Description copied from interface: IFileListDescriptor

The content types of the files that might be contained in the list of files. Each content type is a MIME type. Use "*/*" when the content type is unknown or any type of file might be contained in the list. An empty set allows no files.

null is treated as if the empty set had been returned.

Specified by:

getContentTypes in interface IFileListDescriptor

Returns:

The content types of the files that might be contained in the list of files.

getDescription

public String getDescription()

Description copied from interface: IFileListDescriptor

Gets the description for the file. Can be either a localized message or an I18N key.

Specified by:

getDescription in interface IFileListDescriptor

Returns:

I18n key pointing to a description for the file.

getMaxFileCount

public int getMaxFileCount()

Description copied from interface: IFileListDescriptor

The maximum number of files that will be contained in the list of files. MAX_VALUE when there is no limit.

Specified by:

getMaxFileCount in interface IFileListDescriptor

Returns:

The maximum number of files that will be contained in the list of files.

getMinFileCount

public int getMinFileCount()

Description copied from interface: IFileListDescriptor

The minimum number of files that are contained in the list of files. 0 when the list might be empty, 1 if the list will contain at least one file.

Specified by:

getMinFileCount in interface IFileListDescriptor

Returns:

The minimum number of files that are contained in the list of files.

intersect

public IFileListDescriptor intersect(IFileListDescriptor other)

Description copied from interface: IFileListDescriptor

Intersects this file list descriptor with another file list descriptor. The intersection of two file list descriptors is a new file list descriptor that only allows files that are allowed by both file list descriptors. When the two file list descriptors are incompatible, returns an empty descriptor.

Specified by:

intersect in interface IFileListDescriptor

Parameters:

other - The other file list descriptor to intersect with.

Returns:

The intersection of this file list descriptor with the other file list descriptor.

isDescriptionHtml

public boolean isDescriptionHtml()

Description copied from interface: IFileListDescriptor

Whether the IFileListDescriptor.getDescription() is an HTML string (make sure it's valid and properly escaped!). When false, the description is treated as plain text.

Specified by:

isDescriptionHtml in interface IFileListDescriptor

Returns:

Whether the description is an HTML string.

isDescriptionI18nKey

public boolean isDescriptionI18nKey()

Description copied from interface: IFileListDescriptor

Whether the IFileListDescriptor.getDescription() is an I18N key that needs to be looked up in a resource bundle. When false, the description value is used as-is.

Specified by:

isDescriptionI18nKey in interface IFileListDescriptor

Returns:

Whether the description is an I18N key (true) or a plain text description (false).

any

public static IFileListDescriptor any()

Returns an IFileListDescriptor that allows any file type and any number of files.

Returns:

A descriptor that allows any file type and any number of files.

empty

public static IFileListDescriptor empty()

Returns an empty IFileListDescriptor that does not allow any files.

Returns:

An empty descriptor that does not allow any files.

fileListDescriptorBuilder

public static FileListDescriptor.Builder fileListDescriptorBuilder()

Creates a new builder for FileListDescriptor.

Returns:

A new builder for a file list descriptor.