Package de.xima.fc.workflow
Class FileValueDescriptor
- java.lang.Object
-
- de.xima.fc.workflow.FileValueDescriptor
-
- All Implemented Interfaces:
IFileValueDescriptor
,Serializable
public class FileValueDescriptor extends Object implements IFileValueDescriptor
POJO implementation ofIFileValueDescriptor
.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FileValueDescriptor.Builder
Builder for a file value descriptor.
-
Field Summary
-
Fields inherited from interface de.xima.fc.interfaces.workflow.execution.IFileValueDescriptor
DEFAULT_FILE_KEY
-
-
Constructor Summary
Constructors Constructor Description FileValueDescriptor(String descriptionI18n)
Deprecated.UsefileValueDescriptorBuilder()
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IFileValueBuilder
builder()
Creates a builder for building a file value that conforms to this file value descriptor.static IFileValueDescriptor
empty()
Creates an empty file value descriptor for when no files are provided.static IFileValueDescriptor
emptyFileValueDescriptorIfNull(IFileValueDescriptor fileValueDescriptor)
Returns the given file value descriptor if it is not null, or an empty file value descriptor otherwise.static FileValueDescriptor.Builder
fileValueDescriptorBuilder()
Creates a new builder for a file value descriptor.String
getDescriptionI18n()
Deprecated.Map<String,IFileListDescriptor>
getFiles()
Gets the descriptor for the list of files provided by the workflow element.IFileValueDescriptor
intersect(IFileValueDescriptor other)
Intersects this file value descriptor with another file value descriptor.-
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.IFileValueDescriptor
allowsAnyFiles
-
-
-
-
Constructor Detail
-
FileValueDescriptor
@Deprecated public FileValueDescriptor(String descriptionI18n)
Deprecated.UsefileValueDescriptorBuilder()
instead. UseIFileValueDescriptor.DEFAULT_FILE_KEY
as the key for the default file list.Creates a new POJO implementation ofIFileValueDescriptor
with the given data.- Parameters:
descriptionI18n
- The value that is returned byIFileValueDescriptor.getDescriptionI18n()
.
-
-
Method Detail
-
getDescriptionI18n
@Deprecated public String getDescriptionI18n()
Deprecated.Description copied from interface:IFileValueDescriptor
Gets the I18n key pointing to a description for the file.- Specified by:
getDescriptionI18n
in interfaceIFileValueDescriptor
- Returns:
- I18n key pointing to a description for the file.
-
getFiles
public Map<String,IFileListDescriptor> getFiles()
Description copied from interface:IFileValueDescriptor
Gets the descriptor for the list of files provided by the workflow element. Different types of files may be provided. The map key is an internal technical identifier for the file type. UseIFileValueDescriptor.DEFAULT_FILE_KEY
as the key for the default list of files. For example, a workflow action that creates a certificate might provide different a file for the certificate signing request, a file for the private key, and a file for the public key.- Specified by:
getFiles
in interfaceIFileValueDescriptor
- Returns:
- The descriptor for the list of files provided by the workflow element.
-
intersect
public IFileValueDescriptor intersect(IFileValueDescriptor other)
Description copied from interface:IFileValueDescriptor
Intersects this file value descriptor with another file value descriptor. The intersection of two file value descriptors is a new value list descriptor that only allows files that are allowed by both file list descriptors. When the two file value descriptors are incompatible, returns anempty
descriptor.- Specified by:
intersect
in interfaceIFileValueDescriptor
- Parameters:
other
- The other file value descriptor to intersect with.- Returns:
- The intersection of this file value descriptor with the other file value descriptor.
-
builder
public IFileValueBuilder builder()
Description copied from interface:IFileValueDescriptor
Creates a builder for building a file value that conforms to this file value descriptor.- Specified by:
builder
in interfaceIFileValueDescriptor
- Returns:
- A builder for building a file value that conforms to this file value descriptor.
-
empty
public static IFileValueDescriptor empty()
Creates an empty file value descriptor for when no files are provided.- Returns:
- An empty file value descriptor.
-
emptyFileValueDescriptorIfNull
public static IFileValueDescriptor emptyFileValueDescriptorIfNull(IFileValueDescriptor fileValueDescriptor)
Returns the given file value descriptor if it is not null, or an empty file value descriptor otherwise.- Parameters:
fileValueDescriptor
- The file value descriptor to return if it is not null.- Returns:
- The given file value descriptor if it is not null, or an empty file value descriptor otherwise.
-
fileValueDescriptorBuilder
public static FileValueDescriptor.Builder fileValueDescriptorBuilder()
Creates a new builder for a file value descriptor.- Returns:
- A new builder for a file value descriptor.
- Since:
- 8.2.0
-
-