summaryrefslogtreecommitdiff
path: root/java/src/Ice/ObjectHolder.java
diff options
context:
space:
mode:
Diffstat (limited to 'java/src/Ice/ObjectHolder.java')
-rw-r--r--java/src/Ice/ObjectHolder.java32
1 files changed, 32 insertions, 0 deletions
diff --git a/java/src/Ice/ObjectHolder.java b/java/src/Ice/ObjectHolder.java
index 6c31f835607..9201f7ce4af 100644
--- a/java/src/Ice/ObjectHolder.java
+++ b/java/src/Ice/ObjectHolder.java
@@ -9,27 +9,51 @@
package Ice;
+/**
+ * Holder class for Ice objects that are in- or inout-parameters.
+ **/
public final class ObjectHolder
{
+ /**
+ * Instantiates the class with a <code>null</code> value.
+ **/
public
ObjectHolder()
{
}
+ /**
+ * Instantiates the class with the passed Ice object.
+ **/
public
ObjectHolder(Ice.Object value)
{
this.value = value;
}
+ /**
+ * This class allows the unmarshaling code to patch the reference
+ * to the Ice object in this holder once the Ice object has been unmarshaled.
+ **/
public class Patcher implements IceInternal.Patcher
{
+ /**
+ * Sets the Ice object of this holder to the passed instance.
+ *
+ * @param v The new object for this holder.
+ **/
public void
patch(Ice.Object v)
{
value = v;
}
+ /**
+ * Returns the Slice type ID of the most-derived Slice type supported
+ * by this instance.
+ *
+ * @return The Slice type ID.
+ **/
public String
type()
{
@@ -37,11 +61,19 @@ public final class ObjectHolder
}
}
+ /**
+ * Returns the patcher for this Ice object.
+ *
+ * @return The patcher for this Ice object.
+ **/
public Patcher
getPatcher()
{
return new Patcher();
}
+ /**
+ * The Ice object stored by this holder.
+ **/
public Ice.Object value;
}