com.lf.digester.cli

Class DigesterCLIUtils

java.lang.Object

com.lf.digester.cli.DigesterCLIUtils

public class DigesterCLIUtils
extends java.lang.Object

Provides some useful functionality for use with the digester classes.

Since:

1.5

Version:

$Revision: 1.50 $, $Date: 2015/01/08 09:03:43 $

Author:

Axel Schwolow

Constructor Summary

Constructors

Constructor and Description
DigesterCLIUtils() Constructor method for i18n purposes only.

Method Summary

Methods

Modifier and Type	Method and Description
protected static com.lf.commons.config.Configuration	convertFromCheckCLIArgs(java.util.Hashtable<java.lang.String,java.lang.String[]> options) Converts the given command line arguments for digestercli to option window parameters.
protected static com.lf.commons.config.Configuration	convertFromGenerateCLIArgs(java.util.Hashtable<java.lang.String,java.lang.String[]> options, java.util.Hashtable<java.lang.String,java.util.Vector<java.lang.String[]>> multiargs, com.lf.commons.config.Configuration defaults, java.util.Hashtable<java.lang.String,java.lang.Object> clivalues, com.lf.commons.crypto.CryptoManager cryptomanager) Converts the given command line arguments for digestercli to option window parameters.
protected static com.lf.commons.config.Configuration	convertFromRefreshCLIArgs(java.util.Hashtable<java.lang.String,java.lang.String[]> options, java.util.Hashtable<java.lang.String,java.util.Vector<java.lang.String[]>> multiargs, com.lf.commons.config.Configuration defaults, java.util.Hashtable<java.lang.String,java.lang.Object> clivalues, com.lf.commons.crypto.CryptoManager cryptomanager) Converts the given command line arguments for digestercli to option window parameters.
protected static com.lf.commons.config.Configuration	convertFromSyncCLIArgs(java.util.Hashtable<java.lang.String,java.lang.String[]> options, java.util.Hashtable<java.lang.String,java.util.Vector<java.lang.String[]>> multiargs, com.lf.commons.config.Configuration defaults, java.util.Vector<java.lang.String> flipholder, java.util.Hashtable<java.lang.String,java.lang.Object> clivalues) Converts the given command line arguments for digestercli to option window parameters (sync).
static java.lang.String	convertToCheckAnt(com.lf.commons.config.Configuration config, java.io.File[] targetfiles, org.apache.commons.vfs2.FileObject[] targeturls) Converts the given option window parameters to Ant build script fragments.
static java.lang.String[]	convertToCheckCLIArgs(com.lf.commons.config.Configuration config, java.io.File[] targetfiles, org.apache.commons.vfs2.FileObject[] targeturls, boolean argsonly) Converts the given option window parameters to command line arguments for digestercli.
static java.lang.String	convertToGenerateAnt(com.lf.commons.config.Configuration config, java.io.File[] targetfiles, org.apache.commons.vfs2.FileObject[] targeturls, boolean refresh) Converts the given option window parameters to Ant build script fragments.
static java.lang.String[]	convertToGenerateCLIArgs(com.lf.commons.config.Configuration config, java.io.File[] targetfiles, org.apache.commons.vfs2.FileObject[] targeturls, boolean argsonly, boolean refresh, boolean pgpkeyargs) Converts the given option window parameters to command line arguments for digestercli.
static java.lang.String	convertToSyncAnt(com.lf.commons.config.Configuration config, java.lang.String activetargetset, com.lf.commons.lang.OrderedHashtable<java.lang.Object,java.lang.Object[]> entries, java.lang.String[] targetsetnames) Converts the given option window parameters to Ant build script fragments.
static java.lang.String[]	convertToSyncCLIArgs(com.lf.commons.config.Configuration config, boolean argsonly, com.lf.commons.lang.OrderedHashtable<java.lang.Object,java.lang.Object[]> entries, java.lang.String activetargetset, java.lang.String[] targetsetnames) Converts the given option window parameters to command line arguments for sync mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

DigesterCLIUtils

public DigesterCLIUtils()
                 throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

Method Detail

convertToCheckCLIArgs

public static java.lang.String[] convertToCheckCLIArgs(com.lf.commons.config.Configuration config,
                                       java.io.File[] targetfiles,
                                       org.apache.commons.vfs2.FileObject[] targeturls,
                                       boolean argsonly)

Converts the given option window parameters to command line arguments for digestercli.

Parameters:

config - Settings for checking

targetfiles - The files/directories to be processed

targeturls - The URLs/directories to be processed

argsonly - Omit the application and target files/directories?

Returns:

Command line arguments

Since:

1.6

convertToGenerateCLIArgs

public static java.lang.String[] convertToGenerateCLIArgs(com.lf.commons.config.Configuration config,
                                          java.io.File[] targetfiles,
                                          org.apache.commons.vfs2.FileObject[] targeturls,
                                          boolean argsonly,
                                          boolean refresh,
                                          boolean pgpkeyargs)

Converts the given option window parameters to command line arguments for digestercli.

Parameters:

config - Settings for generating

targetfiles - The files/directories to be processed

targeturls - The URLs/directories to be processed

argsonly - Omit the application and target files/directories?

refresh - Provide options for refresh (generate otherwise)?

pgpkeyargs - Include PGP key arguments (false for Ant)?

Returns:

Command line arguments

Since:

1.6

convertToSyncCLIArgs

public static java.lang.String[] convertToSyncCLIArgs(com.lf.commons.config.Configuration config,
                                      boolean argsonly,
                                      com.lf.commons.lang.OrderedHashtable<java.lang.Object,java.lang.Object[]> entries,
                                      java.lang.String activetargetset,
                                      java.lang.String[] targetsetnames)

Converts the given option window parameters to command line arguments for sync mode.

Parameters:

config - Settings for sync (template)

argsonly - Omit the application?

entries - The source/target entries

activetargetset - The name of the active target set, required for "-flipsourcetarget"

targetsetnames - The target set identifiers

Returns:

Command line arguments

Since:

1.6

convertToCheckAnt

public static java.lang.String convertToCheckAnt(com.lf.commons.config.Configuration config,
                                 java.io.File[] targetfiles,
                                 org.apache.commons.vfs2.FileObject[] targeturls)

Converts the given option window parameters to Ant build script fragments.

Parameters:

config - Settings for generating

targetfiles - The files/directories to be processed

targeturls - The URLs/directories to be processed

Returns:

Ant fragment, null indicates error

Since:

1.6

convertToGenerateAnt

public static java.lang.String convertToGenerateAnt(com.lf.commons.config.Configuration config,
                                    java.io.File[] targetfiles,
                                    org.apache.commons.vfs2.FileObject[] targeturls,
                                    boolean refresh)

Converts the given option window parameters to Ant build script fragments.

Parameters:

config - Settings for generating

targetfiles - The files/directories to be processed

targeturls - The URLs/directories to be processed

refresh - Provide options for refresh (generate otherwise)?

Returns:

Ant fragment, null indicates error

Since:

1.6

convertToSyncAnt

public static java.lang.String convertToSyncAnt(com.lf.commons.config.Configuration config,
                                java.lang.String activetargetset,
                                com.lf.commons.lang.OrderedHashtable<java.lang.Object,java.lang.Object[]> entries,
                                java.lang.String[] targetsetnames)

Converts the given option window parameters to Ant build script fragments.

Parameters:

config - Settings for generating

activetargetset - The name of the active target set, required for "-flipsourcetarget"

entries - The source/target entries

targetsetnames - The target set names

Returns:

Ant fragment, null indicates error

Since:

1.6

convertFromCheckCLIArgs

protected static com.lf.commons.config.Configuration convertFromCheckCLIArgs(java.util.Hashtable<java.lang.String,java.lang.String[]> options)

Converts the given command line arguments for digestercli to option window parameters.

Parameters:

options - Command line arguments

Returns:

Options container for checking

Since:

1.6

convertFromGenerateCLIArgs

protected static com.lf.commons.config.Configuration convertFromGenerateCLIArgs(java.util.Hashtable<java.lang.String,java.lang.String[]> options,
                                                             java.util.Hashtable<java.lang.String,java.util.Vector<java.lang.String[]>> multiargs,
                                                             com.lf.commons.config.Configuration defaults,
                                                             java.util.Hashtable<java.lang.String,java.lang.Object> clivalues,
                                                             com.lf.commons.crypto.CryptoManager cryptomanager)

Converts the given command line arguments for digestercli to option window parameters.

For some options the default values are activated if the flag/option is missing.

Parameters:

options - Command line arguments

multiargs - The command line arguments showing up multiple times

defaults - The default values e.g. from template (optional)

clivalues - The cache for the command line values (e.g. entries)

cryptomanager - The PGP crypto manager

Returns:

Options container for generating

Since:

1.6

convertFromRefreshCLIArgs

protected static com.lf.commons.config.Configuration convertFromRefreshCLIArgs(java.util.Hashtable<java.lang.String,java.lang.String[]> options,
                                                            java.util.Hashtable<java.lang.String,java.util.Vector<java.lang.String[]>> multiargs,
                                                            com.lf.commons.config.Configuration defaults,
                                                            java.util.Hashtable<java.lang.String,java.lang.Object> clivalues,
                                                            com.lf.commons.crypto.CryptoManager cryptomanager)

Converts the given command line arguments for digestercli to option window parameters.

For some options the default values are activated if the flag/option is missing.

Parameters:

options - Command line arguments

multiargs - The command line arguments showing up multiple times

defaults - The default values e.g. from template (optional)

clivalues - The cache for the command line values (e.g. entries)

cryptomanager - The PGP crypto manager

Returns:

Options container for refreshing

Since:

1.6

convertFromSyncCLIArgs

protected static com.lf.commons.config.Configuration convertFromSyncCLIArgs(java.util.Hashtable<java.lang.String,java.lang.String[]> options,
                                                         java.util.Hashtable<java.lang.String,java.util.Vector<java.lang.String[]>> multiargs,
                                                         com.lf.commons.config.Configuration defaults,
                                                         java.util.Vector<java.lang.String> flipholder,
                                                         java.util.Hashtable<java.lang.String,java.lang.Object> clivalues)

Converts the given command line arguments for digestercli to option window parameters (sync).

For some options the default values are activated if the flag/option is missing. While the trivial values like the many flags are transported via the config object, the explicitely passed values like the entries are collected here in the clivalues container. The flip values are transported separately since it should be possible to specify a template and also the flip mode option while the other parameters are "all-or-none".

Parameters:

options - Command line arguments

multiargs - The command line arguments showing up multiple times

defaults - The default values e.g. from template (optional)

flipholder - The container holding the flip target set name, empty = no flip

clivalues - The cache for the command line values (e.g. entries)

Returns:

Options container for generating

Since:

1.6