Package de.xima.fc.workflow.processor.value.common

Class FileItemDescriptor

java.lang.Object

de.xima.fc.workflow.processor.value.wrapper.RecordValueDescriptorWrapper

de.xima.fc.workflow.processor.value.common.FileItemDescriptor

All Implemented Interfaces:

IRecordValueDescriptor, IValueDescriptor<Map<String,?>,IRecordValueBuilder>, Serializable

public final class FileItemDescriptor
extends RecordValueDescriptorWrapper

A IValueDescriptor for the metadata of a file, consisting of a file name, base name, extension, and file size.

See Also:

Serialized Form

Field Summary

Fields inherited from class de.xima.fc.workflow.processor.value.wrapper.RecordValueDescriptorWrapper

delegate

Method Summary

Modifier and Type	Method	Description
static <E extends IFileEntity<?,?> & IFileSizeProviding> Map<String,Object>	valueFileItem(E file)	Creates a value that conforms to the FileItemDescriptor value descriptor.
static <E extends IFileEntity<?,?> & IFileSizeProviding> Map<String,Object>	valueFileItem(E file, Map<String,Object> mimeType)	Creates a value that conforms to the FileItemDescriptor value descriptor.
static Map<String,Object>	valueFileItem(File file)	Creates a value that conforms to the FileItemDescriptor value descriptor.
static Map<String,Object>	valueFileItem(String fileName, long fileSizeBytes)	Creates a value that conforms to the FileItemDescriptor value descriptor.
static Map<String,Object>	valueFileItem(String fileName, String mimeType, long fileSizeBytes)	Creates a value that conforms to the FileItemDescriptor value descriptor.
static Map<String,Object>	valueFileItem(String fileName, Map<String,Object> mimeType, long fileSizeBytes)	Creates a value that conforms to the FileItemDescriptor value descriptor.
static Map<String,Object>	valueFileItem(String fileName, javax.activation.MimeType mimeType, long fileSizeBytes)	Creates a value that conforms to the FileItemDescriptor value descriptor.
static Map<String,Object>	valueFileItem(Path file)	Creates a value that conforms to the FileItemDescriptor value descriptor.
static Map<String,Object>	valueFileItem(Path file, String mimeType)	Creates a value that conforms to the FileItemDescriptor value descriptor.
static Map<String,Object>	valueFileItem(Path file, Map<String,Object> mimeType)	Creates a value that conforms to the FileItemDescriptor value descriptor.
static Map<String,Object>	valueFileItem(Path file, javax.activation.MimeType mimeType)	Creates a value that conforms to the FileItemDescriptor value descriptor.

Methods inherited from class de.xima.fc.workflow.processor.value.wrapper.RecordValueDescriptorWrapper

acceptsValue, asAny, asBoolean, asConst, asFloat, asInteger, asLargeString, asList, asList, asMap, asMap, asNull, asRecord, asString, asTuple, asUnion, asUnion, asVoid, builder, configure, getBaseType, getDefaultValue, getDescription, getFullType, getJavaClass, getKnownProperties, getKnownProperties, getRecordValueDescriptors, intersect, is, toString, unwrap, withDefaultValue, withDescription

Methods inherited from class java.lang.Object

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

Method Detail

valueFileItem

public static Map<String,Object> valueFileItem(Path file,
                                                     Map<String,Object> mimeType)

Creates a value that conforms to the FileItemDescriptor value descriptor.

Parameters:

file - A file.

mimeType - Mime type of the file, see MimeTypeDescriptor.valueMimeType(MimeType).

Returns:

A file item value conforming to FileItemDescriptor.

valueFileItem

public static Map<String,Object> valueFileItem(Path file)

Creates a value that conforms to the FileItemDescriptor value descriptor. Guesses the mime type.

Parameters:

file - A file.

Returns:

A file item value conforming to FileItemDescriptor.

valueFileItem

public static Map<String,Object> valueFileItem(File file)

Creates a value that conforms to the FileItemDescriptor value descriptor. Guesses the mime type.

Parameters:

file - A file.

Returns:

A file item value conforming to FileItemDescriptor.

valueFileItem

public static <E extends IFileEntity<?,?> & IFileSizeProviding> Map<String,Object> valueFileItem(E file,
                                                                                                             Map<String,Object> mimeType)

Creates a value that conforms to the FileItemDescriptor value descriptor.

Parameters:

file - A file.

mimeType - Mime type of the file, see MimeTypeDescriptor.valueMimeType(MimeType).

Returns:

A file item value conforming to FileItemDescriptor.

valueFileItem

public static <E extends IFileEntity<?,?> & IFileSizeProviding> Map<String,Object> valueFileItem(E file)

Creates a value that conforms to the FileItemDescriptor value descriptor. Guesses the mime type.

Parameters:

file - A file.

Returns:

A file item value conforming to FileItemDescriptor.

valueFileItem

public static Map<String,Object> valueFileItem(Path file,
                                                     javax.activation.MimeType mimeType)

Creates a value that conforms to the FileItemDescriptor value descriptor.

Parameters:

file - A file.

mimeType - Mime type of the file.

Returns:

A file item value conforming to FileItemDescriptor.

valueFileItem

public static Map<String,Object> valueFileItem(Path file,
                                                     String mimeType)

Creates a value that conforms to the FileItemDescriptor value descriptor.

Parameters:

file - A file.

mimeType - Mime type of the file.

Returns:

A file item value conforming to FileItemDescriptor.

valueFileItem

public static Map<String,Object> valueFileItem(String fileName,
                                                     Map<String,Object> mimeType,
                                                     long fileSizeBytes)

Creates a value that conforms to the FileItemDescriptor value descriptor.

Parameters:

fileName - Name of the file.

mimeType - Mime type of the file, see MimeTypeDescriptor.valueMimeType(MimeType).

fileSizeBytes - File size in bytes.

Returns:

A file item value conforming to FileItemDescriptor.

valueFileItem

public static Map<String,Object> valueFileItem(String fileName,
                                                     javax.activation.MimeType mimeType,
                                                     long fileSizeBytes)

Creates a value that conforms to the FileItemDescriptor value descriptor.

Parameters:

fileName - Name of the file.

mimeType - Mime type of the file.

fileSizeBytes - File size in bytes.

Returns:

A file item value conforming to FileItemDescriptor.

valueFileItem

public static Map<String,Object> valueFileItem(String fileName,
                                                     String mimeType,
                                                     long fileSizeBytes)

Creates a value that conforms to the FileItemDescriptor value descriptor.

Parameters:

fileName - Name of the file.

mimeType - Mime type of the file.

fileSizeBytes - File size in bytes.

Returns:

A file item value conforming to FileItemDescriptor.

valueFileItem

public static Map<String,Object> valueFileItem(String fileName,
                                                     long fileSizeBytes)

Creates a value that conforms to the FileItemDescriptor value descriptor. Guesses the mime type.

Parameters:

fileName - Name of the file.

fileSizeBytes - File size in bytes.

Returns:

A file item value conforming to FileItemDescriptor.