1. /*
  2. * @(#)CharHolder.java 1.25 00/02/02
  3. *
  4. * Copyright 1995-2000 Sun Microsystems, Inc. All Rights Reserved.
  5. *
  6. * This software is the proprietary information of Sun Microsystems, Inc.
  7. * Use is subject to license terms.
  8. *
  9. */
  10. package org.omg.CORBA;
  11. import org.omg.CORBA.portable.Streamable;
  12. import org.omg.CORBA.portable.InputStream;
  13. import org.omg.CORBA.portable.OutputStream;
  14. /**
  15. * A Holder class for a <code>char</code>
  16. * that is used to store "out" and "inout" parameters in IDL methods.
  17. * If an IDL method signature has an IDL <code>char</code> as an "out"
  18. * or "inout" parameter, the programmer must pass an instance of
  19. * <code>CharHolder</code> as the corresponding
  20. * parameter in the method invocation; for "inout" parameters, the programmer
  21. * must also fill the "in" value to be sent to the server.
  22. * Before the method invocation returns, the ORB will fill in the
  23. * value corresponding to the "out" value returned from the server.
  24. * <P>
  25. * If <code>myCharHolder</code> is an instance of <code>CharHolder</code>,
  26. * the value stored in its <code>value</code> field can be accessed with
  27. * <code>myCharHolder.value</code>.
  28. *
  29. * @version 1.14, 09/09/97
  30. * @since JDK1.2
  31. */
  32. public final class CharHolder implements Streamable {
  33. /**
  34. * The <code>char</code> value held by this <code>CharHolder</code>
  35. * object.
  36. */
  37. public char value;
  38. /**
  39. * Constructs a new <code>CharHolder</code> object with its
  40. * <code>value</code> field initialized to <code>0</code>.
  41. */
  42. public CharHolder() {
  43. }
  44. /**
  45. * Constructs a new <code>CharHolder</code> object for the given
  46. * <code>char</code>.
  47. * @param initial the <code>char</code> with which to initialize
  48. * the <code>value</code> field of the new
  49. * <code>CharHolder</code> object
  50. */
  51. public CharHolder(char initial) {
  52. value = initial;
  53. }
  54. /**
  55. * Reads from <code>input</code> and initalizes the value in
  56. * this <code>CharHolder</code> object
  57. * with the unmarshalled data.
  58. *
  59. * @param input the InputStream containing CDR formatted data from the wire
  60. */
  61. public void _read(InputStream input) {
  62. value = input.read_char();
  63. }
  64. /**
  65. * Marshals to <code>output</code> the value in
  66. * this <code>CharHolder</code> object.
  67. *
  68. * @param output the OutputStream which will contain the CDR formatted data
  69. */
  70. public void _write(OutputStream output) {
  71. output.write_char(value);
  72. }
  73. /**
  74. * Returns the <code>TypeCode</code> object corresponding
  75. * to the value held in
  76. * this <code>CharHolder</code> object.
  77. *
  78. * @return the TypeCode of the value held in
  79. * this <code>CharHolder</code> object
  80. */
  81. public org.omg.CORBA.TypeCode _type() {
  82. return ORB.init().get_primitive_tc(TCKind.tk_char);
  83. }
  84. }