[commit] r1377 - trunk/SDK/Java/java/org/isis/jaut
GMESRC Repository Notifications
gme-commit at list.isis.vanderbilt.edu
Tue Jun 21 12:26:18 CDT 2011
Author: ksmyth
Date: Tue Jun 21 12:26:18 2011
New Revision: 1377
Log:
Fix spelling in javadocs
Modified:
trunk/SDK/Java/java/org/isis/jaut/Apartment.java
trunk/SDK/Java/java/org/isis/jaut/ApartmentObject.java
trunk/SDK/Java/java/org/isis/jaut/ComException.java
trunk/SDK/Java/java/org/isis/jaut/Dispatch.java
trunk/SDK/Java/java/org/isis/jaut/InvokeException.java
trunk/SDK/Java/java/org/isis/jaut/Variant.java
Modified: trunk/SDK/Java/java/org/isis/jaut/Apartment.java
==============================================================================
--- trunk/SDK/Java/java/org/isis/jaut/Apartment.java Tue Jun 21 12:25:48 2011 (r1376)
+++ trunk/SDK/Java/java/org/isis/jaut/Apartment.java Tue Jun 21 12:26:18 2011 (r1377)
@@ -73,10 +73,10 @@
/**
* Initialize the COM library for the calling Thread. It sets the Thread concurrency model.
* This function is a direct wrapper around the <code>CoInitializeEx</code> COM function.
- * Every succesfull invocation must be matched by a {@link #coUninitialize} call.
+ * Every successful invocation must be matched by a {@link #coUninitialize} call.
* Do not use <code>coInitialize</code> directly, use {@link #enter} instead.
*
- * @param coInit the requested concurreny model. Acceptable values are combined
+ * @param coInit the requested concurrency model. Acceptable values are combined
* from the COINIT_XXX constants.
* @throws ComException if <code>CoInitializeEx</code> fails.
* @see #coUninitialize
@@ -114,7 +114,7 @@
/**
* Returns the current Apartment for this Thread.
*
- * @return the Apartment that this Thread enetered, or <code>null</code>
+ * @return the Apartment that this Thread entered, or <code>null</code>
* if this Thread is not part of any Apartment.
*/
public static Apartment currentApartment()
@@ -174,7 +174,7 @@
*
* @param multiThreaded <code>true</code> if the multi threaded apartment is requested
* ({@link #COINIT_MULTITHREADED}), <code>false</code> otherwise ({@link #COINIT_APARTMENTTHREADED}).
- * @return the Apartment this Thread enetered.
+ * @return the Apartment this Thread entered.
* @throws JAutException if this Thread is already part of an apartment
* @throws ComException if {@link #coInitialize} fails. This indicates that
* this thread is already part of a COM apartment (entered without using this method),
@@ -296,7 +296,7 @@
protected static Apartment multiThreadedApartment;
/**
- * Retrives the multi threaded apartment (MTA) of the process.
+ * Retrieves the multi threaded apartment (MTA) of the process.
*
* @return the single multi threaded apartment of the process,
* or <code>null</code> if no Java thread is part of the MTA.
Modified: trunk/SDK/Java/java/org/isis/jaut/ApartmentObject.java
==============================================================================
--- trunk/SDK/Java/java/org/isis/jaut/ApartmentObject.java Tue Jun 21 12:25:48 2011 (r1376)
+++ trunk/SDK/Java/java/org/isis/jaut/ApartmentObject.java Tue Jun 21 12:26:18 2011 (r1377)
@@ -48,7 +48,7 @@
protected Apartment apartment;
/**
- * Retrives the {@link Apartment} in which this object was created in.
+ * Retrieves the {@link Apartment} in which this object was created in.
*/
public Apartment getApartment()
{
Modified: trunk/SDK/Java/java/org/isis/jaut/ComException.java
==============================================================================
--- trunk/SDK/Java/java/org/isis/jaut/ComException.java Tue Jun 21 12:25:48 2011 (r1376)
+++ trunk/SDK/Java/java/org/isis/jaut/ComException.java Tue Jun 21 12:26:18 2011 (r1377)
@@ -91,7 +91,7 @@
}
/**
- * Retrives the error message of an error code.
+ * Retrieves the error message of an error code.
* This function wraps the <code>FormatMessage</code> Win32 function.
*
* @param hResult the COM error code (<code>HRESULT</code> or <code>SCODE</code>).
Modified: trunk/SDK/Java/java/org/isis/jaut/Dispatch.java
==============================================================================
--- trunk/SDK/Java/java/org/isis/jaut/Dispatch.java Tue Jun 21 12:25:48 2011 (r1376)
+++ trunk/SDK/Java/java/org/isis/jaut/Dispatch.java Tue Jun 21 12:26:18 2011 (r1377)
@@ -107,7 +107,7 @@
* <code>VT_UNKNOWN</code> or <code>VT_UNKNOWN|VT_BYREF</code> holding the new interface pointer.
* @throws ComException is the <code>IUnknown::QueryInterface</code> method fails.
* @throws JAutException if the target Variant does not have its underlying <code>VARIANT</code> created,
- * or it is not of the porper type.
+ * or it is not of the proper type.
*/
public native void attach(Variant target) throws ComException;
@@ -164,7 +164,7 @@
/**
* Returns a hash code value for the object. The actual returned value is the <code>IUnknown</code>
- * interface pointer of this Dispatch object, obtained by using the </code>IUnknow::QueryInterface</code>
+ * interface pointer of this Dispatch object, obtained by using the </code>IUnknown::QueryInterface</code>
* method.
*
* @return a hash code value for this object.
@@ -191,7 +191,7 @@
* functions.
*
* @param iID the interface ID of the new interface, in the format of "{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}".
- * The retrived interface must be derived from <code>IDispatch</code>.
+ * The retrieved interface must be derived from <code>IDispatch</code>.
* @throws JAutException if the current interface pointer of this object is <code>NULL</code>.
* @throws ComException if either <code>IIDFromString</code> or <code>IUnknown::QueryInterface</code> fails.
*/
@@ -232,7 +232,7 @@
/**
* A class context allowing local servers.
- * The code that creates and manages obejcts of this class is an executable EXE running in a separate process
+ * The code that creates and manages objects of this class is an executable EXE running in a separate process
* on the same machine.
*
* @see #attachNewInstance
@@ -273,7 +273,7 @@
* Sets the interface pointer of the Dispatch object to a running object. First, the existing interface pointer
* is release. Second, the program ID is transformed to a class ID using the <code>CLSIDFromProgID</code>
* Automation function. Then the <code>GetActiveObject</code> and <code>IUnknown::QueryInterface</code>
- * methods are called to retrive the <code>IDispatch</code> interface pointer of the active object.
+ * methods are called to retrieve the <code>IDispatch</code> interface pointer of the active object.
*
* @param progID the program ID of the active object that has been registered.
* @throws ComException if one of the Automation functions fails.
@@ -330,7 +330,7 @@
public static final int DISPATCH_METHOD = 0x1;
/**
- * The member is retrived as a property or data member.
+ * The member is retrieved as a property or data member.
* If a method has the same name, both this and {@link #DISPATCH_METHOD} flag may be set.
*
* @see #invoke(int, int, Variant[], int[], Variant) invoke
@@ -352,7 +352,7 @@
public static final int DISPATCH_PROPERTYPUTREF = 0x8;
/**
- * Invokes a method, or sets or retrives a property of an Automation object.
+ * Invokes a method, or sets or retrieves a property of an Automation object.
* This method is a direct wrapper around the <code>IDispatch::Invoke</code> Automation function.
*
* @param dispID the dispatch ID of the method or property to be invoked.
@@ -360,7 +360,7 @@
* {@link #DISPATCH_METHOD}, {@link #DISPATCH_PROPERTYGET}, {@link #DISPATCH_PROPERTYPUT}
* and {@link #DISPATCH_PROPERTYPUTREF}.
* @param arguments the arguments of the method or property. This can be <code>null</code>
- * if there are no arguments. If an element of the <code>arguements</code> list is
+ * if there are no arguments. If an element of the <code>arguments</code> list is
* null, or its underlying <code>VARIANT</code> is not created, then that parameter
* will be passed as an <code>DISP_E_PARAMNOTFOUND</code> value of type <code>VT_ERROR</code>.
* @param namedArgDispIDs a list of dispatch IDs for named arguments. This can be <code>null</code>
@@ -378,7 +378,7 @@
public native void invoke(int dispID, int dispFlags, Variant[] arguments, int[] namedArgDispIDs, Variant retval);
/**
- * Invokes a method, or retrives a property of an Automation object.
+ * Invokes a method, or retrieves a property of an Automation object.
* First, the the non-<code>null</code> arguments are converted to Variants
* with the {@link Variant#Variant(Object)} constructor,
* then {@link #invoke(int, int, Variant[], int[], Variant)} is called.
@@ -427,7 +427,7 @@
}
/**
- * Invokes a subrutine, or sets a property of an Automation object.
+ * Invokes a subroutine, or sets a property of an Automation object.
* First, the the non-<code>null</code> arguments are converted to Variants
* with the {@link Variant#Variant(Object)} constructor,
* then {@link #invoke(int, int, Variant[], int[], Variant)} is called.
@@ -530,7 +530,7 @@
}
/**
- * Invokes an Automation subrutine with one argument.
+ * Invokes an Automation subroutine with one argument.
* @see #invokeSub(String, int, Object[], int[])
*/
public void callSub(String dispName, Object arg0)
@@ -539,7 +539,7 @@
}
/**
- * Invokes an Automation subrutine with two arguments.
+ * Invokes an Automation subroutine with two arguments.
* @see #invokeSub(String, int, Object[], int[])
*/
public void callSub(String dispName, Object arg0, Object arg1)
@@ -548,7 +548,7 @@
}
/**
- * Invokes an Automation subrutine with three arguments.
+ * Invokes an Automation subroutine with three arguments.
* @see #invokeSub(String, int, Object[], int[])
*/
public void callSub(String dispName, Object arg0, Object arg1, Object arg2)
@@ -557,7 +557,7 @@
}
/**
- * Invokes an Automation subrutine with a list of arguments.
+ * Invokes an Automation subroutine with a list of arguments.
* @see #invokeSub(String, int, Object[], int[])
*/
public void callSub(String dispName, Object[] args)
@@ -566,7 +566,7 @@
}
/**
- * Retrives an Automation property.
+ * Retrieves an Automation property.
* @see #invoke(String, int, Object[], int[])
*/
public Object get(String dispName)
@@ -575,7 +575,7 @@
}
/**
- * Retrives an Automation property with one argument.
+ * Retrieves an Automation property with one argument.
* @see #invoke(String, int, Object[], int[])
*/
public Object get(String dispName, Object arg0)
Modified: trunk/SDK/Java/java/org/isis/jaut/InvokeException.java
==============================================================================
--- trunk/SDK/Java/java/org/isis/jaut/InvokeException.java Tue Jun 21 12:25:48 2011 (r1376)
+++ trunk/SDK/Java/java/org/isis/jaut/InvokeException.java Tue Jun 21 12:26:18 2011 (r1377)
@@ -73,7 +73,7 @@
/**
* Returns the detailed message string for this exception.
*
- * @return the detailed error message, if avaiable.
+ * @return the detailed error message, if available.
*/
public String getMessage()
{
Modified: trunk/SDK/Java/java/org/isis/jaut/Variant.java
==============================================================================
--- trunk/SDK/Java/java/org/isis/jaut/Variant.java Tue Jun 21 12:25:48 2011 (r1376)
+++ trunk/SDK/Java/java/org/isis/jaut/Variant.java Tue Jun 21 12:26:18 2011 (r1377)
@@ -107,7 +107,7 @@
/**
* A variant type denoting a date. This is mapped to <code>double</code>, but
- * the correct Java {@link java.util.Date} can be retrived and set with the methods
+ * the correct Java {@link java.util.Date} can be retrieved and set with the methods
* {@link #getDate} and {@link #setDate}.
*
* @see #getVartype
@@ -160,7 +160,7 @@
public static final int VT_UNKNOWN = 13;
/**
- * A decimal value variant type. This is currently not mapped, and cannot be retrived directly.
+ * A decimal value variant type. This is currently not mapped, and cannot be retrieved directly.
*
* @see #getVartype
*/
@@ -343,7 +343,7 @@
* Creates a Variant of from an Object.
* If <code>value</code> is <code>null</code>, then a Variant of type {@link #VT_EMPTY} is created.
* Otherwise, a Variant will be created with one of the constructors that accept a single parameter.
- * Note, that if <code>value</code> is a Variant, then a Variant reffering to the data in <code>value</code>
+ * Note, that if <code>value</code> is a Variant, then a Variant referring to the data in <code>value</code>
* will be created by {@link #Variant(Variant)}.
*
* @param value an Object
@@ -483,7 +483,7 @@
/**
* Tests if the underlying <code>VARIANT</code> exists.
*
- * @return <code>true</code> if the underlying <code>VARIANT</code> exsists, <code>false</code> otherwise.
+ * @return <code>true</code> if the underlying <code>VARIANT</code> exists, <code>false</code> otherwise.
* @see #allocate(int)
*/
public boolean isCreated()
@@ -535,7 +535,7 @@
* Converts the Variant to another type. This is a direct wrapper method around the <code>VariantChangeType</code>
* Automation function.
*
- * @param destination the destination Variant to hold the coerced value. If <code>destionation</code> is
+ * @param destination the destination Variant to hold the coerced value. If <code>destination</code> is
* the same as <code>this</code> or <code>null</code>, the Variant will be converted in place.
* @param changeFlag flags controlling the coercion. Acceptable values are combined from
* the four <code>VARIANT_XXX</code> constants.
@@ -570,7 +570,7 @@
* like with {@link #clear()}. Then <code>destination</code> receives an exact copy of this Variant
* and all of its owned resources (in the case of {@link #VT_BSTR}, {@link #VT_UNKNOWN},
* {@link #VT_DISPATCH} and {@link #VT_ARRAY}). If the Variant is a reference (anything with
- * {@link #VT_BYREF}), the corresponding resouce is not owned and is not copied.
+ * {@link #VT_BYREF}), the corresponding resource is not owned and is not copied.
* This method is a direct wrapper around the <code>VariantCopy</code> Automation function.
*
* @param destination the destination Variant to hold the copied value.
@@ -599,7 +599,7 @@
public native void copyInd(Variant destination) throws ComException;
/**
- * Retrives the <code>boolean</code> value in the Variant.
+ * Retrieves the <code>boolean</code> value in the Variant.
* The type of the Variant must be {@link #VT_BOOL} or <code>VT_BOOL|VT_BYREF</code>.
*
* @return the <code>boolean</code> value in the Variant.
@@ -619,7 +619,7 @@
public native void setBoolean(boolean value);
/**
- * Retrives the <code>byte</code> value in the Variant.
+ * Retrieves the <code>byte</code> value in the Variant.
* The type of the Variant must be {@link #VT_UI1}, {@link #VT_I1},
* <code>VT_UI1|VT_BYREF</code> or <code>VT_I1|VT_BYREF</code>.
*
@@ -641,7 +641,7 @@
public native void setByte(byte value);
/**
- * Retrives the <code>short</code> value in the Variant.
+ * Retrieves the <code>short</code> value in the Variant.
* The type of the Variant must be {@link #VT_I2}, {@link #VT_UI1},
* <code>VT_I1|VT_BYREF</code> or <code>VT_UI1|VT_BYREF</code>.
*
@@ -663,7 +663,7 @@
public native void setShort(short value);
/**
- * Retrives the <code>int</code> value in the Variant.
+ * Retrieves the <code>int</code> value in the Variant.
* The type of the Variant must be {@link #VT_I4}, {@link #VT_UI4}, {@link #VT_ERROR}, {@link #VT_INT}, {@link #VT_UINT},
* <code>VT_I1|VT_BYREF</code>, <code>VT_UI1|VT_BYREF</code>, <code>VT_ERROR|VT_BYREF</code>,
* <code>VT_INT|VT_BYREF</code> or <code>VT_UINT|VT_BYREF</code>.
@@ -687,7 +687,7 @@
public native void setInt(int value);
/**
- * Retrives the <code>long</code> value in the Variant.
+ * Retrieves the <code>long</code> value in the Variant.
* The type of the Variant must be {@link #VT_CY} or <code>VT_CY|VT_BYREF</code>.
*
* @return the <code>long</code> value in the Variant.
@@ -709,7 +709,7 @@
public native void setLong(long value);
/**
- * Retrives the <code>float</code> value in the Variant.
+ * Retrieves the <code>float</code> value in the Variant.
* The type of the Variant must be {@link #VT_R4} or <code>VT_R4|VT_BYREF</code>.
*
* @return the <code>float</code> value in the Variant.
@@ -729,7 +729,7 @@
public native void setFloat(float value);
/**
- * Retrives the <code>double</code> value in the Variant.
+ * Retrieves the <code>double</code> value in the Variant.
* The type of the Variant must be {@link #VT_R8}, <code>VT_R8|VT_BYREF</code>,
* {@link #VT_DATE} or <code>VT_DATE|VT_BYREF</code>. Note, that Win32 dates
* are stored as doubles in a <code>VARIANT</code>.
@@ -753,7 +753,7 @@
public native void setDouble(double value);
/**
- * Retrives the <code>String</code> value in the Variant.
+ * Retrieves the <code>String</code> value in the Variant.
* The type of the Variant must be {@link #VT_BSTR} or <code>VT_BSTR|VT_BYREF</code>.
*
* @return the <code>String</code> value in the Variant.
@@ -784,8 +784,8 @@
static final long MILLISECONDS_IN_DAY = 1000 * 60 * 60 * 24;
/**
- * Retrives the {@link java.util.Date} in the Variant.
- * This method performs the neccessary transformation from the Win32 date to the Jave date.
+ * Retrieves the {@link java.util.Date} in the Variant.
+ * This method performs the necessary transformation from the Win32 date to the Jave date.
* The type of the Variant must be {@link #VT_DATE}, <code>VT_DATE|VT_BYREF</code>,
* {@link #VT_R8} or <code>VT_R8|VT_BYREF</code>.
*
@@ -802,7 +802,7 @@
/**
* Sets the {@link java.util.Date} in the Variant.
- * This method performs the neccessary transformation from the Java date to the Win32 date.
+ * This method performs the necessary transformation from the Java date to the Win32 date.
* The returned object is the correct Java date corresponding to the Win32 date in the <code>VARIANT</code>.
* The type of the Variant must be {@link #VT_DATE}, <code>VT_DATE|VT_BYREF</code>,
* {@link #VT_R8} or <code>VT_R8|VT_BYREF</code>.
@@ -818,7 +818,7 @@
}
/**
- * Retrives the {@link Dispatch} object in the Variant.
+ * Retrieves the {@link Dispatch} object in the Variant.
* The type of the Variant must be {@link #VT_DISPATCH}, <code>VT_DISPATCH|VT_BYREF</code>,
* {@link #VT_UNKNOWN} or <code>VT_UNKNOWN|VT_BYREF</code>.
* The method invokes <code>QueryInterface</code> to obtain the <code>IDispatch</code> interface
@@ -873,7 +873,7 @@
public native void allocateArray(int vartype, int[] lowerBounds, int[] elements) throws ComException;
/**
- * Retrives the {@link SafeArray} object in the Variant.
+ * Retrieves the {@link SafeArray} object in the Variant.
* The underlying <code>SAFEARRAY</code> structure is always owned by the Variant, the
* {@link SafeArray} object has only access to it. {@link SafeArray} locks the <code>SAFEARRAY</code>
* with the <code>SafeArrayLock</code> Automation function, until {@link SafeArray#release} is called.
@@ -929,7 +929,7 @@
public static int defaultChangeFlags = 0;
/**
- * Coerces the Varian to a {@link #VT_BOOL} and returns the coerced value.
+ * Coerces the Variant to a {@link #VT_BOOL} and returns the coerced value.
*
* @return the coerced <code>bool</code> value.
* @see #changeType
@@ -944,7 +944,7 @@
}
/**
- * Coerces the Varian to a {@link #VT_UI1} and returns the coerced value.
+ * Coerces the Variant to a {@link #VT_UI1} and returns the coerced value.
*
* @return the coerced <code>byte</code> value.
* @see #changeType
@@ -959,7 +959,7 @@
}
/**
- * Coerces the Varian to a {@link #VT_I2} and returns the coerced value.
+ * Coerces the Variant to a {@link #VT_I2} and returns the coerced value.
*
* @return the coerced <code>short</code> value.
* @see #changeType
@@ -974,7 +974,7 @@
}
/**
- * Coerces the Varian to a {@link #VT_I4} and returns the coerced value.
+ * Coerces the Variant to a {@link #VT_I4} and returns the coerced value.
*
* @return the coerced <code>int</code> value.
* @see #changeType
@@ -989,7 +989,7 @@
}
/**
- * Coerces the Varian to a {@link #VT_CY} and returns the coerced value.
+ * Coerces the Variant to a {@link #VT_CY} and returns the coerced value.
*
* @return the coerced currency as a <code>long</code> value.
* @see #changeType
@@ -1005,7 +1005,7 @@
}
/**
- * Coerces the Varian to a {@link #VT_R4} and returns the coerced value.
+ * Coerces the Variant to a {@link #VT_R4} and returns the coerced value.
*
* @return the coerced <code>float</code> value.
* @see #changeType
@@ -1020,7 +1020,7 @@
}
/**
- * Coerces the Varian to a {@link #VT_R8} and returns the coerced value.
+ * Coerces the Variant to a {@link #VT_R8} and returns the coerced value.
*
* @return the coerced <code>double</code> value.
* @see #changeType
@@ -1035,7 +1035,7 @@
}
/**
- * Coerces the Varian to a {@link #VT_BSTR} and returns the coerced value.
+ * Coerces the Variant to a {@link #VT_BSTR} and returns the coerced value.
*
* @return the coerced <code>String</code> value.
* @see #changeType
@@ -1050,7 +1050,7 @@
}
/**
- * Coerces the Varian to a {@link #VT_DATE} and returns the coerced value.
+ * Coerces the Variant to a {@link #VT_DATE} and returns the coerced value.
*
* @return the coerced <code>Data</code> value.
* @see #changeType
@@ -1065,7 +1065,7 @@
}
/**
- * Coerces the Varian to a {@link #VT_DISPATCH} and returns the coerced Automation object.
+ * Coerces the Variant to a {@link #VT_DISPATCH} and returns the coerced Automation object.
*
* @return the coerced {@link Dispatch} value.
* @see #changeType
@@ -1081,8 +1081,8 @@
/**
* Returns the value of the Variant in a Java object.
- * If the Variant is of a simple datetype or referes to a simple datatype, then a new inmutable
- * Java object is returned of the correspnding type (for example {@link java.lang.Double} for {@link #VT_R8}).
+ * If the Variant is of a simple datetype or refers to a simple datatype, then a new immutable
+ * Java object is returned of the corresponding type (for example {@link java.lang.Double} for {@link #VT_R8}).
* Otherwise, the value is already represented as an Object, and that object is returned.
* If the type is <code>VT_EMPTY</code> or <code>VT_NULL</code>, then the returned object is <code>null</code>.
* This method does not work for arrays and Variants of type <code>VT_VARIANT|VT_BYREF</code>.
More information about the gme-commit
mailing list