Package com.logicaldoc.core.conversion
Class NotAvailableConverter
- java.lang.Object
-
- com.logicaldoc.core.conversion.NotAvailableConverter
-
- All Implemented Interfaces:
FormatConverter
public class NotAvailableConverter extends Object implements FormatConverter
A converter that always convert into a static PDF that says 'not available'- Since:
- 7.6.4
- Author:
- Marco Meschieri - LogicalDOC
-
-
Constructor Summary
Constructors Constructor Description NotAvailableConverter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
convert(File src, File dest)
Performs the conversionvoid
convert(String sid, Document document, File src, File dest)
Performs the conversionString
getParameter(String name)
Gets the value of a parameterList<String>
getParameterNames()
Implementations should return the list of the required parameters.Map<String,String>
getParameters()
Returns the map of parametersboolean
isEnabled()
Checks if the converter is enabled or notvoid
loadParameters()
Reads it's own parameters and stores them in the parameters mapvoid
setEnabled(boolean enabled)
Enables or disables the converter
-
-
-
Method Detail
-
convert
public void convert(File src, File dest) throws IOException
Description copied from interface:FormatConverter
Performs the conversion- Specified by:
convert
in interfaceFormatConverter
- Parameters:
src
- The source filedest
- The converted file, the extension of it's filename defines the output format- Throws:
IOException
- raised if the conversion resulted in an error
-
convert
public void convert(String sid, Document document, File src, File dest) throws IOException
Description copied from interface:FormatConverter
Performs the conversion- Specified by:
convert
in interfaceFormatConverter
- Parameters:
sid
- The actual Session ID (optional)document
- The document (optional)src
- The source filedest
- The converted file, the extension of it's filename defines the output format- Throws:
IOException
- raised if the conversion resulted in an error
-
getParameterNames
public List<String> getParameterNames()
Description copied from interface:FormatConverter
Implementations should return the list of the required parameters. A parameter is stored in the context as converter.SimpleClassName.parameter = value- Specified by:
getParameterNames
in interfaceFormatConverter
- Returns:
- list of the configuration parameters
-
getParameters
public Map<String,String> getParameters()
Description copied from interface:FormatConverter
Returns the map of parameters- Specified by:
getParameters
in interfaceFormatConverter
- Returns:
- map param_name = param_value
-
getParameter
public String getParameter(String name)
Description copied from interface:FormatConverter
Gets the value of a parameter- Specified by:
getParameter
in interfaceFormatConverter
- Parameters:
name
- name of the configuration parameter- Returns:
- the value of the configuration parameter
-
loadParameters
public void loadParameters()
Description copied from interface:FormatConverter
Reads it's own parameters and stores them in the parameters map- Specified by:
loadParameters
in interfaceFormatConverter
-
isEnabled
public boolean isEnabled()
Description copied from interface:FormatConverter
Checks if the converter is enabled or not- Specified by:
isEnabled
in interfaceFormatConverter
- Returns:
- if the converter is enabled
-
setEnabled
public void setEnabled(boolean enabled)
Description copied from interface:FormatConverter
Enables or disables the converter- Specified by:
setEnabled
in interfaceFormatConverter
- Parameters:
enabled
- the enabled flag
-
-