View Javadoc
1   /*
2    * Copyright (c) 2001, 2003, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package com.sun.corba.se.pept.encoding;
27  
28  import java.io.IOException;
29  
30  import com.sun.corba.se.pept.protocol.MessageMediator;
31  
32  /**
33   * <p> An <code>InputObject</code> is the interface used by the
34   * presentation block to get programming language typed data from data
35   *  encoded in a message. </p>
36   *
37   * <p> The implementation of an <code>InputObject</code> contains the
38   * encoded data.  When the presentation block asks for data the
39   * implementation of <code>InputObject</code> is responsible for converting
40   * the encoded representation of the data to the types expected by the
41   * programming language.</p>
42   *
43   * <p>A particular <em>encoding</em> would subclass
44   * <code>InputObject</code>.  The subclass would provide methods to get
45   * the data types appropriate to the presentation block (e.g., simple
46   * types such as int or boolean, all the way to any type derived from
47   * <code>java.io.Serializable</code>.).</p>
48   *
49   * <p>Note: the protocol block may also use the <code>InputObject</code> to
50   * obtain header metadata.</p>
51   *
52   * @author Harold Carr
53  */
54  public interface InputObject
55  {
56      public void setMessageMediator(MessageMediator messageMediator);
57  
58      public MessageMediator getMessageMediator();
59  
60      public void close() throws IOException;
61  }
62  
63  // End of file.