Package org.verapdf.apps

Class Applications

java.lang.Object

org.verapdf.apps.Applications

public final class Applications
extends Object

Version:

0.1 Created 31 Oct 2016:13:15:23

Author:

Carl Wilson carlwilson AT github

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Applications.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static String	APP_HOME_PROPERTY
static String	DEFAULT_CONFIG_ROOT_NAME
static String	UPDATE_LATEST_VERSION
static String	UPDATE_OLD_VERSION
static String	UPDATE_SERVICE_NOT_AVAILABLE
static String	UPDATE_URI

Method Summary

Modifier and Type	Method	Description
static void	checkArgNotNull(Object arg, String argName)
static ConfigManager	createAppConfigManager()	Shortcut method to find configuration in the local user directory or, if it doesn't exist, to create configuration in the application installation configuration directory, if installation configuration directory is not writable method shall create configuration in the local user directory.
static Applications.Builder	createConfigBuilder(VeraAppConfig base)
static ConfigManager	createConfigManager(File root)
static ConfigManager	createTmpConfigManager()	Shortcut method to create a configuration in the temp directory.
static VeraAppConfig	defaultConfig()
static Applications.Builder	defaultConfigBuilder()
static org.verapdf.apps.VeraAppConfigImpl	fromXml(InputStream toConvert)
static org.verapdf.apps.VeraAppConfigImpl	fromXml(Reader toConvert)
static org.verapdf.apps.VeraAppConfigImpl	fromXml(String toConvert)
static ReleaseDetails	getAppDetails()
static File	getVeraScriptFile()
static SoftwareUpdater	softwareUpdater()
static void	toXml(VeraAppConfig toConvert, OutputStream stream, Boolean prettyXml)
static void	toXml(VeraAppConfig toConvert, Writer writer, Boolean prettyXml)
static String	toXml(VeraAppConfig toConvert, Boolean prettyXml)

Methods inherited from class java.lang.Object

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

Field Detail

APP_HOME_PROPERTY

public static final String APP_HOME_PROPERTY

See Also:

Constant Field Values

DEFAULT_CONFIG_ROOT_NAME

public static final String DEFAULT_CONFIG_ROOT_NAME

See Also:

Constant Field Values

UPDATE_SERVICE_NOT_AVAILABLE

public static final String UPDATE_SERVICE_NOT_AVAILABLE

See Also:

Constant Field Values

UPDATE_LATEST_VERSION

public static final String UPDATE_LATEST_VERSION

See Also:

Constant Field Values

UPDATE_OLD_VERSION

public static final String UPDATE_OLD_VERSION

See Also:

Constant Field Values

UPDATE_URI

public static final String UPDATE_URI

See Also:

Constant Field Values

Method Detail

getVeraScriptFile

public static File getVeraScriptFile()

getAppDetails

public static ReleaseDetails getAppDetails()

Returns:

the Application Release details for the GUI

createConfigManager

public static ConfigManager createConfigManager(File root)

Parameters:

root - the root directory for the configuration, should contain the veraPDF configuration files, if not default ones are created.

Returns:

a ConfigManager instance populated using the configuration files at root.

createAppConfigManager

public static ConfigManager createAppConfigManager()

Shortcut method to find configuration in the local user directory or, if it doesn't exist, to create configuration in the application installation configuration directory, if installation configuration directory is not writable method shall create configuration in the local user directory.

Returns:

a ConfigManager instance populated using the configuration files in the application config directory.

createTmpConfigManager

public static ConfigManager createTmpConfigManager()

Shortcut method to create a configuration in the temp directory.

Returns:

a ConfigManager instance populated using the configuration files in the temp directory.

defaultConfig

public static VeraAppConfig defaultConfig()

defaultConfigBuilder

public static Applications.Builder defaultConfigBuilder()

createConfigBuilder

public static Applications.Builder createConfigBuilder(VeraAppConfig base)

toXml

public static String toXml(VeraAppConfig toConvert,
                           Boolean prettyXml)
                    throws JAXBException,
                           IOException

Throws:

JAXBException

IOException

toXml

public static void toXml(VeraAppConfig toConvert,
                         OutputStream stream,
                         Boolean prettyXml)
                  throws JAXBException

Throws:

JAXBException

fromXml

public static org.verapdf.apps.VeraAppConfigImpl fromXml(InputStream toConvert)
                                                  throws JAXBException

Throws:

JAXBException

toXml

public static void toXml(VeraAppConfig toConvert,
                         Writer writer,
                         Boolean prettyXml)
                  throws JAXBException

Throws:

JAXBException

fromXml

public static org.verapdf.apps.VeraAppConfigImpl fromXml(Reader toConvert)
                                                  throws JAXBException

Throws:

JAXBException

fromXml

public static org.verapdf.apps.VeraAppConfigImpl fromXml(String toConvert)
                                                  throws JAXBException

Throws:

JAXBException

softwareUpdater

public static SoftwareUpdater softwareUpdater()

checkArgNotNull

public static void checkArgNotNull(Object arg,
                                   String argName)