/*
===========================================================================

                       Copyright  2002 Allen Baker

---------------------------------------------------------------------------
Class:         SequenceFileNames
Originator:    Allen Baker (2002.11.25)
---------------------------------------------------------------------------
$RCSfile$
$Revision$
$Date$
===========================================================================
*/



/*
===============================================
Package
----------------------------------------------- */
package cosmicabyss.com.app;



/*
===============================================
Imports
----------------------------------------------- */
import java.io.*;
import java.util.*;


import cosmicabyss.com.lib.*;



/*
=========================================================================== *//**
Description<PRE>
   This program renames all the files that are specified by the command
   line arguments.  Each file is given a new file name that includes a
   sequential number starting with 000. A control is provided that lets the
   user specify a number different than 000 to begin the sequencing.
</PRE>

Usage<PRE>
   java cosmicabyss.com.app.SequenceFileNames [-h -q -r -s] [-l [logFile]] {-x fileSpec} [-pfx string] [-sfx string] [-b number] {-ifile fileName} {-xfile fileName} fileSpecs+
      Arguments can be placed in any order on the command line.

   -h means HELP.
      It causes this usage message to be displayed, and terminates the
      program.

   -q means QUIET.
      It stops the program from sending log messages to stdout. The program
      sends log messages to stdout by default; this option is the only way
      to stop it from doing that.

   -r means RECURSE.
      It causes the program to recurse down through the trees of
      subdirectories that are rooted at the directories specified in the
      file specifiers that are on the command line.

   -s means SUBDIRECTORIES.
      It causes the program to match subdirectory names that match the file
      specifiers on the command line.

   -l means LOGFILE.
      It takes an optional file name parameter, and causes the program to
      send log messages to the named file. If the file name is not present,
      the program generates a default file name. If the environment
      variable LOGDIRECTORY is defined, the program places the file in that
      directory. If not, the program places the file in the current
      directory. The program continues to send log messages to stdout too,
      unless the -q option is used.

   -x means EXCLUDE.
      It requires a fileSpec, and causes the program to not process any
      files that match the fileSpec. This control may be put on the command
      line as many times as needed to specify all the files that should be
      excluded from processing.

      Enclosing the fileSpec in quotes is REQUIRED for any fileSpec that
      contains embedded spaces or wildcard characters.

   -pfx means PREFIX.
      It requires a prefix string, and causes all the new file names to be
      prefixed with the specified string. For example, if -pfxnew. is on
      the command line, then the file names would be prefixed with new.,
      like this:
         tunax.jpg -----> new.000.jpg ,
         tunax.jpg -----> new.001.jpg ,
         tunay.jpg -----> new.002.jpg ,
         tunaz.jpg -----> new.003.jpg ,

   -sfx means SUFFIX.
      It requires a suffix string, and causes all the new file names to be
      suffixed with the specified string. For example, if -sfx.old is on
      the command line, then the file names would be suffixed with .old,
      like this:
         tunax.jpg -----> 000.old.jpg ,
         tunax.jpg -----> 001.old.jpg ,
         tunay.jpg -----> 002.old.jpg ,
         tunaz.jpg -----> 003.old.jpg ,

   -b means BEGIN.
      It requires a number, and specifies the beginning number that will be
      used to sequence the file names. For example, if -b23 is on the
      command line, then the files would be sequenced beginning with number
      23, like this:
         tunax.jpg -----> 023.jpg ,
         tunay.jpg -----> 024.jpg ,
         tunaz.jpg -----> 025.jpg ,
         tunaz.jpg -----> 026.jpg ,

   -xfile means EXCLUDE FILE.
      It takes a required file name parameter, and causes the program to
      read each non-empty line in the named file and treat it as the
      filespec argument to a -x control. This control may be put on the
      command line as many times as needed to specify all the files that
      contain filespecs for files that should be excluded from processing.

   -ifile means INCLUDE FILE.
      It takes a required file name parameter, and causes the program to
      read each non-empty line in the named file and treat it as a fileSpec
      that identifies files to include in processing. This control may be
      put on the command line as many times as needed to specify all the
      files that contain filespecs for files that should be included in the
      processing.

   fileSpecs identifies the files to process.
      It is a required parameter and is one or more file specifiers that
      identify the files that the program will process.

      As many fileSpecs may be put on the command line as needed to specify
      all the files that should be included in processing.

      Enclosing the fileSpec in quotes is required for any file specifier
      that contains embedded spaces.

      Enclosing the fileSpec in quotes prevents the command line
      interpreter from trying to replace wildcard characters itself instead
      of letting SequenceFileNames do it.

      The quotes surrounding the fileSpec are not needed if it contains no
      wildcard characters or spaces.
</PRE>

<P>
<DL>
   <DT>
      <B>Example usage:</B>
      <DD>
         <PRE>
            *java cosmicabyss.com.app.SequenceFileNames -r -x"*.bat" "..\*.*"
         </PRE>
      </DD>
   </DT>
   <DT>
      <B>View Source:</B>
      <DD>
         <A href="SequenceFileNames.java.html">
            SequenceFileNames.java
         </A>
      </DD>
   </DT>
   <DT>
      <B>Author:</B>
      <DD>
         <A href="mailto:sourcecode.v01@cosmicabyss.com">
            Allen Baker
         </A>
      </DD>
   </DT>
</DL>
*//*
=========================================================================== */
public class SequenceFileNames
   {



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method creates a SequenceFileNames class object and runs the
   application to completion.

   <P><B>Implementation: </B><A HREF="SequenceFileNames.java.html#000">View source</A>

   @param
      pArgs contains the command line arguments with which the class was
      invoked as an application.
   *//*
   -------------------------------------------------------------- */
   public <Type> SequenceFileNames(Type[] pArgs) throws Exception
      {
      boolean  successCode = true;

      successCode = initialize(pArgs);
      if (successCode)
         {
         successCode = processAllFiles();
         }
      cOut.println
         (
         CLASS_NAME.string() +
         (successCode? " completed successfully." : " completed with problems.")
         );
      cOut.println();
      cOut.stopLog();
      }



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method sets the ConsoleStream for this object.

   <P><B>Implementation: </B><A HREF="SequenceFileNames.java.html#001">View source</A>

   @return
      a reference to this object

   @param
      pConsole is a ConsoleStream through which this objects sends its
      output.
   *//*
   -------------------------------------------------------------- */
   public SequenceFileNames setOut(ConsoleStream pConsole)
      {
      cOut = pConsole;
      return this;
      }



   /*:                 
   ==============================================================
   ============================================================== *//**
   This boilerplate method is used for testing an instantiated object of
   this class and may include any code the developer chooses.

   <P><B>Implementation: </B><A HREF="SequenceFileNames.java.html#002">View source</A>

   @return
      a reference to this object
   *//*
   -------------------------------------------------------------- */
   public SequenceFileNames test() throws Exception
      {
      cOut.titledPrintf
         (
         "\"HELLO WORLD!\"",
         "%s  %s  %s",
         "I'm an object of the", CLASS_NAME, "class, and I approved this message."
         );
      return this;
      }



   /*
   ===================================================================
   ===================================================================
                --------------- Protected ---------------
   =================================================================== */



   /*
   ===================================================================
   ===================================================================
                 --------------- Private ---------------
   =================================================================== */



   /*
   ===============================================
   Class Constants
      CLASS_NAME  : the name of this class
      DESCRIPTION : the man page description of this application
      USAGE       : the man page usage information for this application
   ----------------------------------------------- */
   private static final XString  CLASS_NAME  = new XString(SequenceFileNames.class.getName());
   private static final XString  DESCRIPTION = new XString
      (
      // <Description>  Preprocessor generated String definition, Don't mess with it.
      "This program renames all the files that are specified by the command                                                 \n" +
      "line arguments.  Each file is given a new file name that includes a                                                  \n" +
      "sequential number starting with 000. A control is provided that lets the                                             \n" +
      "user specify a number different than 000 to begin the sequencing.                                                    \n" +
      ""// </Description>
      );
   private static final XString  USAGE       = new XString
      (
      // <Usage>        Preprocessor generated String definition, Don't mess with it.
      "java cosmicabyss.com.app.SequenceFileNames [-h -q -r -s] [-l [logFile]] {-x fileSpec} [-pfx string] [-sfx string] [-b number] {-ifile fileName} {-xfile fileName} fileSpecs+\n" +
      "   Arguments can be placed in any order on the command line.                                                         \n" +
      "                                                                                                                     \n" +
      "-h means HELP.                                                                                                       \n" +
      "   It causes this usage message to be displayed, and terminates the                                                  \n" +
      "   program.                                                                                                          \n" +
      "                                                                                                                     \n" +
      "-q means QUIET.                                                                                                      \n" +
      "   It stops the program from sending log messages to stdout. The program                                             \n" +
      "   sends log messages to stdout by default; this option is the only way                                              \n" +
      "   to stop it from doing that.                                                                                       \n" +
      "                                                                                                                     \n" +
      "-r means RECURSE.                                                                                                    \n" +
      "   It causes the program to recurse down through the trees of                                                        \n" +
      "   subdirectories that are rooted at the directories specified in the                                                \n" +
      "   file specifiers that are on the command line.                                                                     \n" +
      "                                                                                                                     \n" +
      "-s means SUBDIRECTORIES.                                                                                             \n" +
      "   It causes the program to match subdirectory names that match the file                                             \n" +
      "   specifiers on the command line.                                                                                   \n" +
      "                                                                                                                     \n" +
      "-l means LOGFILE.                                                                                                    \n" +
      "   It takes an optional file name parameter, and causes the program to                                               \n" +
      "   send log messages to the named file. If the file name is not present,                                             \n" +
      "   the program generates a default file name. If the environment                                                     \n" +
      "   variable LOGDIRECTORY is defined, the program places the file in that                                             \n" +
      "   directory. If not, the program places the file in the current                                                     \n" +
      "   directory. The program continues to send log messages to stdout too,                                              \n" +
      "   unless the -q option is used.                                                                                     \n" +
      "                                                                                                                     \n" +
      "-x means EXCLUDE.                                                                                                    \n" +
      "   It requires a fileSpec, and causes the program to not process any                                                 \n" +
      "   files that match the fileSpec. This control may be put on the command                                             \n" +
      "   line as many times as needed to specify all the files that should be                                              \n" +
      "   excluded from processing.                                                                                         \n" +
      "                                                                                                                     \n" +
      "   Enclosing the fileSpec in quotes is REQUIRED for any fileSpec that                                                \n" +
      "   contains embedded spaces or wildcard characters.                                                                  \n" +
      "                                                                                                                     \n" +
      "-pfx means PREFIX.                                                                                                   \n" +
      "   It requires a prefix string, and causes all the new file names to be                                              \n" +
      "   prefixed with the specified string. For example, if -pfxnew. is on                                                \n" +
      "   the command line, then the file names would be prefixed with new.,                                                \n" +
      "   like this:                                                                                                        \n" +
      "      tunax.jpg -----> new.000.jpg ,                                                                                 \n" +
      "      tunax.jpg -----> new.001.jpg ,                                                                                 \n" +
      "      tunay.jpg -----> new.002.jpg ,                                                                                 \n" +
      "      tunaz.jpg -----> new.003.jpg ,                                                                                 \n" +
      "                                                                                                                     \n" +
      "-sfx means SUFFIX.                                                                                                   \n" +
      "   It requires a suffix string, and causes all the new file names to be                                              \n" +
      "   suffixed with the specified string. For example, if -sfx.old is on                                                \n" +
      "   the command line, then the file names would be suffixed with .old,                                                \n" +
      "   like this:                                                                                                        \n" +
      "      tunax.jpg -----> 000.old.jpg ,                                                                                 \n" +
      "      tunax.jpg -----> 001.old.jpg ,                                                                                 \n" +
      "      tunay.jpg -----> 002.old.jpg ,                                                                                 \n" +
      "      tunaz.jpg -----> 003.old.jpg ,                                                                                 \n" +
      "                                                                                                                     \n" +
      "-b means BEGIN.                                                                                                      \n" +
      "   It requires a number, and specifies the beginning number that will be                                             \n" +
      "   used to sequence the file names. For example, if -b23 is on the                                                   \n" +
      "   command line, then the files would be sequenced beginning with number                                             \n" +
      "   23, like this:                                                                                                    \n" +
      "      tunax.jpg -----> 023.jpg ,                                                                                     \n" +
      "      tunay.jpg -----> 024.jpg ,                                                                                     \n" +
      "      tunaz.jpg -----> 025.jpg ,                                                                                     \n" +
      "      tunaz.jpg -----> 026.jpg ,                                                                                     \n" +
      "                                                                                                                     \n" +
      "-xfile means EXCLUDE FILE.                                                                                           \n" +
      "   It takes a required file name parameter, and causes the program to                                                \n" +
      "   read each non-empty line in the named file and treat it as the                                                    \n" +
      "   filespec argument to a -x control. This control may be put on the                                                 \n" +
      "   command line as many times as needed to specify all the files that                                                \n" +
      "   contain filespecs for files that should be excluded from processing.                                              \n" +
      "                                                                                                                     \n" +
      "-ifile means INCLUDE FILE.                                                                                           \n" +
      "   It takes a required file name parameter, and causes the program to                                                \n" +
      "   read each non-empty line in the named file and treat it as a fileSpec                                             \n" +
      "   that identifies files to include in processing. This control may be                                               \n" +
      "   put on the command line as many times as needed to specify all the                                                \n" +
      "   files that contain filespecs for files that should be included in the                                             \n" +
      "   processing.                                                                                                       \n" +
      "                                                                                                                     \n" +
      "fileSpecs identifies the files to process.                                                                           \n" +
      "   It is a required parameter and is one or more file specifiers that                                                \n" +
      "   identify the files that the program will process.                                                                 \n" +
      "                                                                                                                     \n" +
      "   As many fileSpecs may be put on the command line as needed to specify                                             \n" +
      "   all the files that should be included in processing.                                                              \n" +
      "                                                                                                                     \n" +
      "   Enclosing the fileSpec in quotes is required for any file specifier                                               \n" +
      "   that contains embedded spaces.                                                                                    \n" +
      "                                                                                                                     \n" +
      "   Enclosing the fileSpec in quotes prevents the command line                                                        \n" +
      "   interpreter from trying to replace wildcard characters itself instead                                             \n" +
      "   of letting SequenceFileNames do it.                                                                               \n" +
      "                                                                                                                     \n" +
      "   The quotes surrounding the fileSpec are not needed if it contains no                                              \n" +
      "   wildcard characters or spaces.                                                                                    \n" +
      ""// </Usage>
      );
   /*
   ===============================================
   Class variables
      cOut : console output.
   ----------------------------------------------- */
   private static ConsoleStream  cOut = ConsoleStream.getSingleton();
   /*
   ===============================================
   Instance variables
      iFileNameList     : the list of all file names that match the
                          filespecs given on the command line.
      iGlobalProperties : a copy of all the environment variables.
      iBegin            : the beginning number of the sequence.
      iPrefix           : the prefix to prepend to the file name.
      iSuffix           : the suffix to append to the file name.
   ----------------------------------------------- */
   private FileNameList      iFileNameList     = null;
   private GlobalProperties  iGlobalProperties = null;
   private int               iBegin            = 0;
   private XString           iPrefix           = XString.EMPTY;
   private XString           iSuffix           = XString.EMPTY;



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method performs the core processing functions of this application.

   <P><B>Implementation: </B><A HREF="SequenceFileNames.java.html#003">View source</A>

   @return
      a success code of true if all goes well, false otherwise.
   *//*
   -------------------------------------------------------------- */
   private boolean processAllFiles() throws Exception
      {
      boolean  successCode = true;
      String   fmtStr;
      /*
      ===============================================
      tell 'em what we're gonna do
      ----------------------------------------------- */
      cOut.println("Plan","Will process " + iFileNameList.size() + " files.");
      if      (iFileNameList.size() > 99999) fmtStr = "%06d";
      else if (iFileNameList.size() >  9999) fmtStr = "%05d";
      else if (iFileNameList.size() >   999) fmtStr = "%04d";
      else if (iFileNameList.size() >    99) fmtStr = "%03d";
      else if (iFileNameList.size() >     9) fmtStr = "%02d";
      else                                   fmtStr = "%d";
      /*
      ===============================================
      We are going to rename all the files in the list from their
      current name to a temporary name first. Then we'll go through them
      again and rename them from their temporary name to their final
      sequentialized name. Make 3 arrays, one containing the current
      names, one containing the temporary names, and one containing the
      new, sequentialized names for each file.
      ----------------------------------------------- */
      XString[]  curNames = new XString[iFileNameList.size()];
      XString[]  tmpNames = new XString[iFileNameList.size()];
      XString[]  newNames = new XString[iFileNameList.size()];
      /*
      ===============================================
      do it for each file in the FileNameList
      ----------------------------------------------- */
      int       i              = 0;
      int       filesProcessed = 0;
      for (XString  fileName : iFileNameList)
         {
         XFile    file          = new XFile(fileName);
         XString  canonicalPath = new XString(file.getCanonicalPath());
         /*
         ===============================================
         tell 'em which file is being processed next
         ----------------------------------------------- */
         filesProcessed++;
         /*
         ===============================================
         the current name
         ----------------------------------------------- */
         curNames[i] = new XString(file.getCanonicalPath());
         /*
         ===============================================
         the temporary name
         ----------------------------------------------- */
         tmpNames[i] = new XString
            (
            file.getParent() +
            "\\"             +
            "$_"             +
            file.getName()
            );
         /*
         ===============================================
         the new sequentialized name
         ----------------------------------------------- */
         newNames[i] = new XString
            (
            file.getParent()                  +
            "\\"                              +
            iPrefix                           +
            UString.alignRight(iBegin,4,'0')  +
            iSuffix                           +
            "."                               +
            file.getExtension()
            );
         iBegin++;
         i++;
         }
      /*
      ===============================================
      format and display some messages that tell the user what the
      files are going to be renamed to.
      ----------------------------------------------- */
      int curLongest = UString.longestStringLength(curNames);
      for (i=0; i<curNames.length; i++)
         {
         cOut.println
            (
            UString.alignLeft(curNames[i]+" ",curLongest+5,'-') +
            "> "                                                +
            newNames[i]
            );
         }
      /*
      ===============================================
      rename each file from its current name to its temporary name.
      (the temporary names guarantee no name collisions when we create
      the new sequentialized names)
      ----------------------------------------------- */
      for (i=0; i<curNames.length; i++)
         {
         XFile  file = new XFile(curNames[i]);
         file.renameTo(tmpNames[i]);
         }
      /*
      ===============================================
      rename each file from its temporary name to its new,
      sequentialized name
      ----------------------------------------------- */
      for (i=0; i<tmpNames.length; i++)
         {
         XFile  file = new XFile(tmpNames[i]);
         file.renameTo(newNames[i]);
         }
      /*
      ===============================================
      tell 'em what we did
      ----------------------------------------------- */
      cOut.println("Result","Processed " + filesProcessed + " of an expected " + iFileNameList.size() + " files.");
      return successCode;
      }



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method displays the command line arguments that this program was
   invoked with.

   <P><B>Implementation: </B><A HREF="SequenceFileNames.java.html#004">View source</A>

   @return
      nothing

   @param
      pArgs contains the command line arguments with which the class was
      invoked as an application.
   *//*
   -------------------------------------------------------------- */
   private <Type> void showArgs(Type[] pArgs) throws Exception
      {
      XString  str = new XString("");
      for (int i=0; i<pArgs.length; i++)
         {
         str = str.concat(UString.toString(pArgs[i]) + "   ");
         }
      cOut.println("Command Line Arguments",str);
      }



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method processes the command line arguments and based on what it
   finds, sets the instance variables.

   <P><B>Implementation: </B><A HREF="SequenceFileNames.java.html#005">View source</A>

   @return
      a success code of true if all goes well, false otherwise.

   @param
      pArgs contains the command line arguments with which the class was
      invoked as an application.
   *//*
   -------------------------------------------------------------- */
   private <Type> boolean initialize(Type[] pArgs) throws Exception
      {
      boolean  successCode = true;
      /*
      ===============================================
      Greetings !
      ----------------------------------------------- */
      System.out.println();
      System.out.println();
      System.out.println();
      System.out.println();
      cOut.banner(CLASS_NAME);
      System.out.println();
      /*
      ===============================================
      tell the user what command line arges this program started with
      ----------------------------------------------- */
      showArgs(pArgs);
      /*
      ===============================================
      this cannot be done statically because it throws an exception.
      ----------------------------------------------- */
      iGlobalProperties = new GlobalProperties();
      /*
      ===============================================
      get ready to process the command line arguments
      ----------------------------------------------- */
      CommandLine  cmdLn = new CommandLine(CLASS_NAME,pArgs);
      /*
      ===============================================
      these are the valid command line controls
      ----------------------------------------------- */
      cmdLn.addControlsFromString(":hqrsl::x:b:");
      cmdLn.addControl("-xfile","required");
      cmdLn.addControl("-ifile","required");
      cmdLn.addControl("-pfx","required");
      cmdLn.addControl("-sfx","required");
      /*
      ===============================================
      list the valid controls
      ----------------------------------------------- */
      cmdLn.listControls();
      cOut.println();
      /*
      ===============================================
      interpret the arguments on the command line
      ----------------------------------------------- */
      HashSet<XString>          controlsWithoutArgs = new HashSet<XString>();
      HashMap<XString,XString>  controlsWithArgs    = new HashMap<XString,XString>();
      ArrayList<XString>        excludedFileSpecs   = new ArrayList<XString>();
      ArrayList<XString>        includedFileSpecs   = new ArrayList<XString>();
      boolean                   result              = cmdLn.commandLineArgs
         (
         iGlobalProperties  ,
         controlsWithoutArgs,
         controlsWithArgs   ,
         excludedFileSpecs  ,
         includedFileSpecs
         );
      /*
      ===============================================
      if the command line was messed up, abort the program
      ----------------------------------------------- */
      if (includedFileSpecs.isEmpty())
         {
         cOut.println("COMMAND LINE ERROR: MANDATORY control NOT on command line:  fileSpecs");
         }
      if ((result == false) || (includedFileSpecs.isEmpty()))
         {
         usage();
         cOut.titledSeverityPrintf
            (
            Const.HALT,
            CLASS_NAME,
            "Command line error."
            );
         cOut.stopLog();
         System.exit(-1);
         }
      /*
      ===============================================
      arguments for the FileNameList with their default values.  Some of
      these arguments may be modified by commandline controls.
      ----------------------------------------------- */
      boolean  recurse             = false;
      boolean  fullyQualifiedNames = true;
      boolean  matchSubdirs        = false;
      boolean  sort                = true;
      boolean  collapse            = false;
      /*
      ===============================================
      process commandline controls without arguments
      ----------------------------------------------- */
      for (XString  ctl : controlsWithoutArgs)
         {
         cOut.println(ctl.string() + " control is present.");
         if (ctl.equals("-h"))
            {
            usage();
            cOut.stopLog();
            System.exit(-1);
            }
         recurse      |= ctl.equals("-r");
         matchSubdirs |= ctl.equals("-s");
         }
      if (controlsWithoutArgs.size() > 0) cOut.println();
      /*
      ===============================================
      process commandline controls with arguments
      ----------------------------------------------- */
      Set<XString>  set = controlsWithArgs.keySet();
      for (XString  ctl : set)
         {
         XString argStr = controlsWithArgs.get(ctl);
         cOut.println(ctl + " control is present with the argument: " + argStr);
         if (ctl.equals("-b"))
            {
            iBegin = UMath.decodeDecimalInt(argStr);
            }
         if (ctl.equals("-pfx"))
            {
            iPrefix = argStr;
            }
         if (ctl.equals("-sfx"))
            {
            iSuffix = argStr;
            }
         }
      if (controlsWithArgs.size() > 0) cOut.println();
      /*
      ===============================================
      get a list of all the files names that will be processed
      ----------------------------------------------- */
      for (XString  fileSpec : includedFileSpecs)
         {
         cOut.println("Files matching this fileSpec will be INcluded: " + fileSpec);
         }
      if (includedFileSpecs.size() > 0) cOut.println();
      for (XString  fileSpec : excludedFileSpecs)
         {
         cOut.println("Files matching this fileSpec will be EXcluded: " + fileSpec);
         }
      if (excludedFileSpecs.size() > 0) cOut.println();
      iFileNameList = new FileNameList
         (
         includedFileSpecs,excludedFileSpecs,recurse,fullyQualifiedNames,matchSubdirs,sort,collapse
         );
      /*
      ===============================================
      ----------------------------------------------- */
      return successCode;
      }



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method writes a usage message to the log

   <P><B>Implementation: </B><A HREF="SequenceFileNames.java.html#006">View source</A>

   @return
      nothing
   *//*
   -------------------------------------------------------------- */
   private void usage()
      {
      cOut.println("Program Description",DESCRIPTION);
      cOut.println("Usage",USAGE);
      }



   /*
   ===================================================================
   ===================================================================
              --------------- Inner Classes ---------------
   =================================================================== */



   /*
   ===================================================================
   ===================================================================
          --------------- Public Static Methods ---------------
   =================================================================== */



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method runs the SequenceFileNames class as a standalone application.
   It's the method that's called when the class is invoked from the command
   line by using the java application launcher - "java".

   Usage<PRE>
   java cosmicabyss.com.app.SequenceFileNames [-h -q -r -s] [-l [logFile]] {-x fileSpec} [-pfx string] [-sfx string] [-b number] {-ifile fileName} {-xfile fileName} fileSpecs+
      Arguments can be placed in any order on the command line.

   -h means HELP.
      It causes this usage message to be displayed, and terminates the
      program.

   -q means QUIET.
      It stops the program from sending log messages to stdout. The program
      sends log messages to stdout by default; this option is the only way
      to stop it from doing that.

   -r means RECURSE.
      It causes the program to recurse down through the trees of
      subdirectories that are rooted at the directories specified in the
      file specifiers that are on the command line.

   -s means SUBDIRECTORIES.
      It causes the program to match subdirectory names that match the file
      specifiers on the command line.

   -l means LOGFILE.
      It takes an optional file name parameter, and causes the program to
      send log messages to the named file. If the file name is not present,
      the program generates a default file name. If the environment
      variable LOGDIRECTORY is defined, the program places the file in that
      directory. If not, the program places the file in the current
      directory. The program continues to send log messages to stdout too,
      unless the -q option is used.

   -x means EXCLUDE.
      It requires a fileSpec, and causes the program to not process any
      files that match the fileSpec. This control may be put on the command
      line as many times as needed to specify all the files that should be
      excluded from processing.

      Enclosing the fileSpec in quotes is REQUIRED for any fileSpec that
      contains embedded spaces or wildcard characters.

   -pfx means PREFIX.
      It requires a prefix string, and causes all the new file names to be
      prefixed with the specified string. For example, if -pfxnew. is on
      the command line, then the file names would be prefixed with new.,
      like this:
         tunax.jpg -----> new.000.jpg ,
         tunax.jpg -----> new.001.jpg ,
         tunay.jpg -----> new.002.jpg ,
         tunaz.jpg -----> new.003.jpg ,

   -sfx means SUFFIX.
      It requires a suffix string, and causes all the new file names to be
      suffixed with the specified string. For example, if -sfx.old is on
      the command line, then the file names would be suffixed with .old,
      like this:
         tunax.jpg -----> 000.old.jpg ,
         tunax.jpg -----> 001.old.jpg ,
         tunay.jpg -----> 002.old.jpg ,
         tunaz.jpg -----> 003.old.jpg ,

   -b means BEGIN.
      It requires a number, and specifies the beginning number that will be
      used to sequence the file names. For example, if -b23 is on the
      command line, then the files would be sequenced beginning with number
      23, like this:
         tunax.jpg -----> 023.jpg ,
         tunay.jpg -----> 024.jpg ,
         tunaz.jpg -----> 025.jpg ,
         tunaz.jpg -----> 026.jpg ,

   -xfile means EXCLUDE FILE.
      It takes a required file name parameter, and causes the program to
      read each non-empty line in the named file and treat it as the
      filespec argument to a -x control. This control may be put on the
      command line as many times as needed to specify all the files that
      contain filespecs for files that should be excluded from processing.

   -ifile means INCLUDE FILE.
      It takes a required file name parameter, and causes the program to
      read each non-empty line in the named file and treat it as a fileSpec
      that identifies files to include in processing. This control may be
      put on the command line as many times as needed to specify all the
      files that contain filespecs for files that should be included in the
      processing.

   fileSpecs identifies the files to process.
      It is a required parameter and is one or more file specifiers that
      identify the files that the program will process.

      As many fileSpecs may be put on the command line as needed to specify
      all the files that should be included in processing.

      Enclosing the fileSpec in quotes is required for any file specifier
      that contains embedded spaces.

      Enclosing the fileSpec in quotes prevents the command line
      interpreter from trying to replace wildcard characters itself instead
      of letting SequenceFileNames do it.

      The quotes surrounding the fileSpec are not needed if it contains no
      wildcard characters or spaces.
   </PRE>

   <P><B>Implementation: </B><A HREF="SequenceFileNames.java.html#007">View source</A>

   @return
      nothing

   @param
      pArgs contains the command line arguments with which the class was
      invoked as an application.
   *//*
   -------------------------------------------------------------- */
   public static void main(String[] pArgs) throws Exception
      {
      SequenceFileNames  thisSequenceFileNames = new SequenceFileNames(pArgs);
      }



   }  // class SequenceFileNames



   /*
   ===================================================================
   ===================================================================
              ------------------- Notes -------------------
   =================================================================== */