com4j.tlbimp.driver.LibConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com4j-maven-plugin Show documentation
The plugin allows you to invoke tlbimp from Maven, so you can use Maven to build Java modules to interface with COM type library
The newest version!
package com4j.tlbimp.driver;
import java.io.File;

public class LibConfig
{
  /**
   * Specify the desired Java package for generated code. This can be used as
   * the alias, without the leading underscore:
   * 
   * 
 
   * <package>com.mycompany.com4j.someprogram</package>
   * 
   * 
 Or as: 

   * <_package>com.mycompany.com4j.someprogram</_package>
   * 

   * 
   * The underscore is there because of the way Maven Mojos are created (the
   * pom.xml tag is the variable name), and "package" is a reserved java word
   * and can't be used as a variable.
   * 
   * @parameter expression="${package}" alias="package"
   *            default-value="org.jvnet.com4j.generated"
   */
  public String _package; // reserved keyword...

  public void setPackage (String s) 
  {
    _package = s;
  }

  /**
   * You must specify either <file> or
   * <libId>. If both are configuration parameters are
   * specified, <libId> will win, and
   * <file> will be ignored.
   * 
   * 
 File is the Win32 program that com4j is generating the COM
   * interface for. This file must exist at the given path. The path can be
   * absolute or relative. Generally this will specify your .exe, .dll, or
   * whatever file has a Windows COM interface. 

   * 
   * 
   * <file>C:\Program Files\iTunes\iTunes.exe</file>
   * 
   * 
   * 
   * @parameter expression="${file}"
   */
  public File file;

  /**
   * You must specify either <file> or
   * <libId>. If both are configuration parameters are
   * specified, <libId> will win, and
   * <file> will be ignored.
   * 
   * 
 LIBID is the Windows identifier of the type library to be
   * processed. It should be a string of the form
   * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. 

   * 
   * Often, the location of type libraries vary from a system to system. For
   * example, the type library for Microsoft Office is installed in the same
   * directory where the user installed Microsoft Office. Because people
   * install things in different places, when multiple people are working on
   * the same project, this makes it difficult to consistently refer to the
   * same type library. libid and libver are useful in this case. Each type
   * library has a unique GUID called "LIBID", and the version of the type
   * library. 
 For example, Microsoft Excel 2000 type library has the
   * LIBID of:

   * 
   * 
   * <libId>00020813-0000-0000-C000-000000000046</libId>
   * 
   * 
   * 

   * and the version of:

   * 
   * 
   * <libVer>1.3</libVer>
   * 
   * 
   * 

   * Together they allow you to reference a type library without knowing its
   * actual location of the file on the disk.
   * 
   * @parameter expression="${libId}"
   */
  public String libId;

  /**
   * Optional library version. Leave empty to designate the latest package
   * based on the libId. This parameter has no effect if
   * <libId> is not used.
   * 
   * @parameter expression="${libVer}"
   */
  public String libVer;
}