[teiid-commits] teiid SVN: r2630 - branches/7.1.x/adminshell/src/main/java/org/teiid/adminshell.

[teiid-commits at lists.jboss.org]

Author: rareddy
Date: 2010-10-06 11:30:16 -0400 (Wed, 06 Oct 2010)
New Revision: 2630

Modified:
   branches/7.1.x/adminshell/src/main/java/org/teiid/adminshell/AdminShell.java
Log:
TEIID-1270: updating the help text for "getAdmin()" method.

Modified: branches/7.1.x/adminshell/src/main/java/org/teiid/adminshell/AdminShell.java
===================================================================
--- branches/7.1.x/adminshell/src/main/java/org/teiid/adminshell/AdminShell.java	2010-10-05 20:36:57 UTC (rev 2629)
+++ branches/7.1.x/adminshell/src/main/java/org/teiid/adminshell/AdminShell.java	2010-10-06 15:30:16 UTC (rev 2630)
@@ -365,7 +365,7 @@
 		return getAdmin().getDataSourceTemplateNames();
 	}
 	
-	@Doc(text = "Get the current Admin connection")
+	@Doc(text = "Get the current org.teiid.adminapi.Admin instance for direct use. Note: Used for advanced usecases to bypass AdminShell methods")
 	public static Admin getAdmin() {
 		if (internalAdmin == null) {
 	        throw new NullPointerException("Not connected.  You must call a \"connectAsAdmin\" method or choose an active connection via \"useConnection\"."); //$NON-NLS-1$