summaryrefslogtreecommitdiff
path: root/java/src/Ice/ObjectPrxHelper.java
diff options
context:
space:
mode:
authorMichi Henning <michi@zeroc.com>2009-06-04 16:19:02 +1000
committerMichi Henning <michi@zeroc.com>2009-06-04 16:19:02 +1000
commit45a3f61401e8c6cccc841fa43a4b35f9f5a444a8 (patch)
tree2d328e013b11a6e3724256cb471f6827c94b6e7d /java/src/Ice/ObjectPrxHelper.java
parentFixed BCC compile errors (diff)
downloadice-45a3f61401e8c6cccc841fa43a4b35f9f5a444a8.tar.bz2
ice-45a3f61401e8c6cccc841fa43a4b35f9f5a444a8.tar.xz
ice-45a3f61401e8c6cccc841fa43a4b35f9f5a444a8.zip
Lots of javadoc comments.
Diffstat (limited to 'java/src/Ice/ObjectPrxHelper.java')
-rw-r--r--java/src/Ice/ObjectPrxHelper.java53
1 files changed, 53 insertions, 0 deletions
diff --git a/java/src/Ice/ObjectPrxHelper.java b/java/src/Ice/ObjectPrxHelper.java
index d22926db9ba..22c553855a8 100644
--- a/java/src/Ice/ObjectPrxHelper.java
+++ b/java/src/Ice/ObjectPrxHelper.java
@@ -11,18 +11,45 @@ package Ice;
public class ObjectPrxHelper extends ObjectPrxHelperBase
{
+ /**
+ * Casts a proxy to <code>::Ice::ObjectPrx</code>. This call contacts
+ * the server and will throw an Ice run-time exception if the target
+ * object does not exist or the server cannot be reached.
+ *
+ * @param b The proxy to cast to <code>::Ice::ObjectPrx</code>.
+ * @return <code>b</code>.
+ **/
public static ObjectPrx
checkedCast(Ice.ObjectPrx b)
{
return b;
}
+ /**
+ * Casts a proxy to <code>::Ice::ObjectPrx</code>. This call contacts
+ * the server and throws an Ice run-time exception if the target
+ * object does not exist or the server cannot be reached.
+ *
+ * @param b The proxy to cast to <code>::Ice::ObjectPrx</code>.
+ * @param ctx The <code>Context</code> map for the invocation.
+ * @return <code>b</code>.
+ **/
public static ObjectPrx
checkedCast(Ice.ObjectPrx b, java.util.Map<String, String> ctx)
{
return b;
}
+ /**
+ * Creates a new proxy that is identical to the passed proxy, except
+ * for its facet. This call contacts
+ * the server and throws an Ice run-time exception if the target
+ * object does not exist, the specified facet does not exist, or the server cannot be reached.
+ *
+ * @param b The proxy to cast to <code>::Ice::ObjectPrx</code>.
+ * @param f The facet for the new proxy.
+ * @return The new proxy with the specified facet.
+ **/
public static ObjectPrx
checkedCast(Ice.ObjectPrx b, String f)
{
@@ -45,6 +72,17 @@ public class ObjectPrxHelper extends ObjectPrxHelperBase
return d;
}
+ /**
+ * Creates a new proxy that is identical to the passed proxy, except
+ * for its facet. This call contacts
+ * the server and throws an Ice run-time exception if the target
+ * object does not exist, the specified facet does not exist, or the server cannot be reached.
+ *
+ * @param b The proxy to cast to <code>::Ice::ObjectPrx</code>.
+ * @param f The facet for the new proxy.
+ * @param ctx The <code>Context</code> map for the invocation.
+ * @return The new proxy with the specified facet.
+ **/
public static ObjectPrx
checkedCast(Ice.ObjectPrx b, String f, java.util.Map<String, String> ctx)
{
@@ -67,12 +105,27 @@ public class ObjectPrxHelper extends ObjectPrxHelperBase
return d;
}
+ /**
+ * Casts a proxy to <code>::Ice::ObjectPrx</code>. This call does
+ * not contact the server and always succeeds.
+ *
+ * @param b The proxy to cast to <code>::Ice::ObjectPrx</code>.
+ * @return <code>b</code>.
+ **/
public static ObjectPrx
uncheckedCast(Ice.ObjectPrx b)
{
return b;
}
+ /**
+ * Creates a new proxy that is identical to the passed proxy, except
+ * for its facet. This call does not contact the server and always succeeds.
+ *
+ * @param b The proxy to cast to <code>::Ice::ObjectPrx</code>.
+ * @param f The facet for the new proxy.
+ * @return The new proxy with the specified facet.
+ **/
public static ObjectPrx
uncheckedCast(Ice.ObjectPrx b, String f)
{