org.acplt.oncrpc
Class XdrBoolean

java.lang.Object
  extended by org.acplt.oncrpc.XdrBoolean
All Implemented Interfaces:
XdrAble

public class XdrBoolean
extends java.lang.Object
implements XdrAble

Instances of the class XdrBoolean represent (de-)serializeable booleans, which are especially useful in cases where a result with only a single boolean is expected from a remote function call or only a single boolean parameter needs to be supplied.

Please note that this class is somewhat modelled after Java's primitive data type wrappers. As for these classes, the XDR data type wrapper classes follow the concept of values with no identity, so you are not allowed to change the value after you've created a value object.


Field Summary
private  boolean value
          The encapsulated boolean value itself.
 
Constructor Summary
XdrBoolean()
          Constructs and initializes a new XdrBoolean object.
XdrBoolean(boolean value)
          Constructs and initializes a new XdrBoolean object.
 
Method Summary
 boolean booleanValue()
          Returns the value of this XdrBoolean object as a boolean primitive.
 void xdrDecode(XdrDecodingStream xdr)
          Decodes -- that is: deserializes -- a XDR boolean from a XDR stream in compliance to RFC 1832.
 void xdrEncode(XdrEncodingStream xdr)
          Encodes -- that is: serializes -- a XDR boolean into a XDR stream in compliance to RFC 1832.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

value

private boolean value
The encapsulated boolean value itself.

Constructor Detail

XdrBoolean

public XdrBoolean(boolean value)
Constructs and initializes a new XdrBoolean object.

Parameters:
value - Boolean value.

XdrBoolean

public XdrBoolean()
Constructs and initializes a new XdrBoolean object.

Method Detail

booleanValue

public boolean booleanValue()
Returns the value of this XdrBoolean object as a boolean primitive.

Returns:
The primitive boolean value of this object.

xdrEncode

public void xdrEncode(XdrEncodingStream xdr)
               throws OncRpcException,
                      java.io.IOException
Encodes -- that is: serializes -- a XDR boolean into a XDR stream in compliance to RFC 1832.

Specified by:
xdrEncode in interface XdrAble
Parameters:
xdr - XDR stream to which information is sent for encoding.
Throws:
OncRpcException - if an ONC/RPC error occurs.
java.io.IOException - if an I/O error occurs.

xdrDecode

public void xdrDecode(XdrDecodingStream xdr)
               throws OncRpcException,
                      java.io.IOException
Decodes -- that is: deserializes -- a XDR boolean from a XDR stream in compliance to RFC 1832.

Specified by:
xdrDecode in interface XdrAble
Parameters:
xdr - XDR stream from which decoded information is retrieved.
Throws:
OncRpcException - if an ONC/RPC error occurs.
java.io.IOException - if an I/O error occurs.