dispatch.java

Very Nice library for using ActiveX controls directly from java without heavy knowledge of JNI, simp

	 * @param lcid
	 * @param wFlags
	 * @param vArg
	 * @param uArgErr
	 * @return Variant returned by underlying invokev
	 */
	public static native Variant invokev(Dispatch dispatchTarget, String name,
			int dispID, int lcid, int wFlags, Variant[] vArg, int[] uArgErr);

	/**
	 * @param dispatchTarget
	 * @param name
	 * @param wFlags
	 * @param vArg
	 * @param uArgErr
	 * @return Variant returned by underlying invokev
	 */
	public static Variant invokev(Dispatch dispatchTarget, String name,
			int wFlags, Variant[] vArg, int[] uArgErr) {
		throwIfUnattachedDispatch(dispatchTarget);
		return invokev(dispatchTarget, name, 0, Dispatch.LOCALE_SYSTEM_DEFAULT,
				wFlags, vArg, uArgErr);
	}

	/**
	 * @param dispatchTarget
	 * @param name
	 * @param wFlags
	 * @param vArg
	 * @param uArgErr
	 * @param wFlagsEx
	 * @return Variant returned by underlying invokev
	 */
	public static Variant invokev(Dispatch dispatchTarget, String name,
			int wFlags, Variant[] vArg, int[] uArgErr, int wFlagsEx) {
		throwIfUnattachedDispatch(dispatchTarget);
		// do not implement IDispatchEx for now
		return invokev(dispatchTarget, name, 0, Dispatch.LOCALE_SYSTEM_DEFAULT,
				wFlags, vArg, uArgErr);
	}

	/**
	 * @param dispatchTarget
	 * @param dispID
	 * @param wFlags
	 * @param vArg
	 * @param uArgErr
	 * @return Variant returned by underlying invokev
	 */
	public static Variant invokev(Dispatch dispatchTarget, int dispID,
			int wFlags, Variant[] vArg, int[] uArgErr) {
		throwIfUnattachedDispatch(dispatchTarget);
		return invokev(dispatchTarget, null, dispID,
				Dispatch.LOCALE_SYSTEM_DEFAULT, wFlags, vArg, uArgErr);
	}

	/*
	 * ============================================================ start of the
	 * invokeSubv section
	 * ===========================================================
	 */

	// removed _Guid argument
	/**
	 * @param dispatchTarget
	 * @param name
	 * @param dispid
	 * @param lcid
	 * @param wFlags
	 * @param oArg
	 * @param uArgErr
	 */
	public static void invokeSub(Dispatch dispatchTarget, String name,
			int dispid, int lcid, int wFlags, Object[] oArg, int[] uArgErr) {
		throwIfUnattachedDispatch(dispatchTarget);
		invokeSubv(dispatchTarget, name, dispid, lcid, wFlags,
				obj2variant(oArg), uArgErr);
	}

	/*
	 * ============================================================ start of the
	 * invokeSub section
	 * ===========================================================
	 */
	/**
	 * @param dispatchTarget
	 * @param name
	 * @param wFlags
	 * @param oArg
	 * @param uArgErr
	 */
	public static void invokeSub(Dispatch dispatchTarget, String name,
			int wFlags, Object[] oArg, int[] uArgErr) {
		throwIfUnattachedDispatch(dispatchTarget);
		invokeSub(dispatchTarget, name, 0, Dispatch.LOCALE_SYSTEM_DEFAULT,
				wFlags, oArg, uArgErr);
	}

	/**
	 * @param dispatchTarget
	 * @param dispid
	 * @param wFlags
	 * @param oArg
	 * @param uArgErr
	 */
	public static void invokeSub(Dispatch dispatchTarget, int dispid,
			int wFlags, Object[] oArg, int[] uArgErr) {
		throwIfUnattachedDispatch(dispatchTarget);
		invokeSub(dispatchTarget, null, dispid, Dispatch.LOCALE_SYSTEM_DEFAULT,
				wFlags, oArg, uArgErr);
	}

	/*
	 * ============================================================ start of the
	 * callSubN section
	 * ===========================================================
	 */
	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param name
	 */
	public static void callSub(Dispatch dispatchTarget, String name) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, name, NO_OBJECT_ARGS);
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param name
	 * @param a1
	 */
	public static void callSub(Dispatch dispatchTarget, String name, Object a1) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, name, new Object[] { a1 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param name
	 * @param a1
	 * @param a2
	 */
	public static void callSub(Dispatch dispatchTarget, String name, Object a1,
			Object a2) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, name, new Object[] { a1, a2 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param name
	 * @param a1
	 * @param a2
	 * @param a3
	 */
	public static void callSub(Dispatch dispatchTarget, String name, Object a1,
			Object a2, Object a3) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, name, new Object[] { a1, a2, a3 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param name
	 * @param a1
	 * @param a2
	 * @param a3
	 * @param a4
	 */
	public static void callSub(Dispatch dispatchTarget, String name, Object a1,
			Object a2, Object a3, Object a4) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, name, new Object[] { a1, a2, a3, a4 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param name
	 * @param a1
	 * @param a2
	 * @param a3
	 * @param a4
	 * @param a5
	 */
	public static void callSub(Dispatch dispatchTarget, String name, Object a1,
			Object a2, Object a3, Object a4, Object a5) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, name, new Object[] { a1, a2, a3, a4, a5 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param name
	 * @param a1
	 * @param a2
	 * @param a3
	 * @param a4
	 * @param a5
	 * @param a6
	 */
	public static void callSub(Dispatch dispatchTarget, String name, Object a1,
			Object a2, Object a3, Object a4, Object a5, Object a6) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, name, new Object[] { a1, a2, a3, a4, a5, a6 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param name
	 * @param a1
	 * @param a2
	 * @param a3
	 * @param a4
	 * @param a5
	 * @param a6
	 * @param a7
	 */
	public static void callSub(Dispatch dispatchTarget, String name, Object a1,
			Object a2, Object a3, Object a4, Object a5, Object a6, Object a7) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, name, new Object[] { a1, a2, a3, a4, a5, a6,
				a7 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param name
	 * @param a1
	 * @param a2
	 * @param a3
	 * @param a4
	 * @param a5
	 * @param a6
	 * @param a7
	 * @param a8
	 */
	public static void callSub(Dispatch dispatchTarget, String name, Object a1,
			Object a2, Object a3, Object a4, Object a5, Object a6, Object a7,
			Object a8) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, name, new Object[] { a1, a2, a3, a4, a5, a6,
				a7, a8 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param dispid
	 */
	public static void callSub(Dispatch dispatchTarget, int dispid) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, dispid, NO_OBJECT_ARGS);
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param dispid
	 * @param a1
	 */
	public static void callSub(Dispatch dispatchTarget, int dispid, Object a1) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, dispid, new Object[] { a1 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param dispid
	 * @param a1
	 * @param a2
	 */
	public static void callSub(Dispatch dispatchTarget, int dispid, Object a1,
			Object a2) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, dispid, new Object[] { a1, a2 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param dispid
	 * @param a1
	 * @param a2
	 * @param a3
	 */
	public static void callSub(Dispatch dispatchTarget, int dispid, Object a1,
			Object a2, Object a3) {
		callSubN(dispatchTarget, dispid, new Object[] { a1, a2, a3 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param dispid
	 * @param a1
	 * @param a2
	 * @param a3
	 * @param a4
	 */
	public static void callSub(Dispatch dispatchTarget, int dispid, Object a1,
			Object a2, Object a3, Object a4) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, dispid, new Object[] { a1, a2, a3, a4 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param dispid
	 * @param a1
	 * @param a2
	 * @param a3
	 * @param a4
	 * @param a5
	 */
	public static void callSub(Dispatch dispatchTarget, int dispid, Object a1,
			Object a2, Object a3, Object a4, Object a5) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, dispid, new Object[] { a1, a2, a3, a4, a5 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param dispid
	 * @param a1
	 * @param a2
	 * @param a3
	 * @param a4
	 * @param a5
	 * @param a6
	 */
	public static void callSub(Dispatch dispatchTarget, int dispid, Object a1,
			Object a2, Object a3, Object a4, Object a5, Object a6) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, dispid,
				new Object[] { a1, a2, a3, a4, a5, a6 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param dispid
	 * @param a1
	 * @param a2
	 * @param a3
	 * @param a4
	 * @param a5
	 * @param a6
	 * @param a7
	 */
	public static void callSub(Dispatch dispatchTarget, int dispid, Object a1,
			Object a2, Object a3, Object a4, Object a5, Object a6, Object a7) {
		throwIfUnattachedDispatch(dispatchTarget);
		callSubN(dispatchTarget, dispid, new Object[] { a1, a2, a3, a4, a5, a6,
				a7 });
	}

	/**
	 * makes call to native callSubN
	 * 
	 * @param dispatchTarget
	 * @param dispid
	 * @param a1
	 * @param a2
	 * @param a3
	 * @param a4
	 * @param a5
	 * @param a6
	 * @param a7
	 * @param a8
	 */
	public static void callSub(Dispatch dispatchTarget, int dispid, Object a1,
			Object a2, Object a3, Object a4, Object a5, Object a6, Object a7,
			Object a8) {
		callSubN(dispatchTarget, dispid, new Object[] { a1, a2, a3, a4, a5, a6,
				a7, a8 });
	}

	/*
	 * ============================================================ start of the
	 * invokev section
	 * ===========================================================
	 */
	/**
	 * Cover for call to underlying invokev()
	 * 
	 * @param dispatchTarget
	 * @param name
	 * @return Variant returned by the request for retrieval of parameter
	 */
	public static Variant get(Dispatch dispatchTarget, String name) {
		throwIfUnattachedDispatch(dispatchTarget);
		return invokev(dispatchTarget, name, Dispatch.Get, NO_VARIANT_ARGS,
				NO_INT_ARGS);
	}

	/**
	 * Cover for call to underlying invokev()
	 * 
	 * @param dispatchTarget
	 * @param dispid
	 * @return Variant returned by the request for retrieval of parameter
	 */
	public static Variant get(Dispatch dispatchTarget, int dispid) {
		throwIfUnattachedDispatch(dispatchTarget);
		return invokev(dispatchTarget, dispid, Dispatch.Get, NO_VARIANT_ARGS,
				NO_INT_ARGS);
	}

	/*
	 * ============================================================ start of the
	 * invoke section
	 * ===========================================================
	 */
	/**
	 * cover for underlying call to invoke
	 * 
	 * @param dispatchTarget
	 * @param name
	 * @param val
	 */
	public static void putRef(Dispatch dispatchTarget, String name, Object val) {
		throwIfUnattachedDispatch(dispatchTarget);
		invoke(dispatchTarget, name, Dispatch.PutRef, new Object[] { val },
				new int[1]);
	}

	/**
	 * cover for underlying call to invoke
	 * 
	 * @param dispatchTarget
	 * @param dispid
	 * @param val
	 */
	public static void putRef(Dispatch dispatchTarget, int dispid, Object val) {
		throwIfUnattachedDispatch(dispatchTarget);
		invoke(dispatchTarget, dispid, Dispatch.PutRef, new Object[] { val },
				new int[1]);
	}

	/**
	 * not implemented yet
	 * 
	 * @param dispatchTarget
	 * @param name
	 * @return Variant never returned
	 * @throws com.jacob.com.NotImplementedException
	 */
	public static Variant get_CaseSensitive(Dispatch dispatchTarget, String name) {
		throw new NotImplementedException("not implemented yet");
	}

}