001/* CookieHolder.java --
002   Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.PortableServer.ServantLocatorPackage;
040
041import org.omg.CORBA.NO_IMPLEMENT;
042import org.omg.CORBA.TypeCode;
043import org.omg.CORBA.portable.InputStream;
044import org.omg.CORBA.portable.OutputStream;
045import org.omg.CORBA.portable.Streamable;
046
047/**
048 * The CookieHolder is used together with the
049 * {@link org.omg.PortableServer.ServantLocator}, allowing the
050 * {@link org.omg.PortableServer.ServantLocatorOperations#preinvoke}
051 * to return an arbitrary java.lang.Object that will be later passed to
052 * {@link org.omg.PortableServer.ServantLocatorOperations#postinvoke}.
053 *
054 * @see org.omg.PortableServer.ServantLocatorOperations
055 * @see org.omg.PortableServer.ServantManager
056 *
057 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
058 */
059public final class CookieHolder
060  implements Streamable
061{
062  /**
063   * The wrapped java.lang.Object.
064   */
065  public java.lang.Object value;
066
067  /**
068   * Create the unitialised instance of this holder.
069   */
070  public CookieHolder()
071  {
072  }
073
074  /**
075   * Create the instance, intialising the {@link #value} field to the passed
076   * value.
077   */
078  public CookieHolder(java.lang.Object initial)
079  {
080    value = initial;
081  }
082
083  /**
084   * java.lang.Object is outside the scope of the CORBA standards and the read
085   * operation cannot be supported in a language-neutral way.
086   *
087   * @throws NO_IMPLEMENT always.
088   */
089  public void _read(InputStream input)
090  {
091    throw new NO_IMPLEMENT();
092  }
093
094  /**
095   * There is no CORBA typecode that would specifically match a java.lang.Object.
096   *
097   * @throws NO_IMPLEMENT always.
098   */
099  public TypeCode _type()
100  {
101    throw new NO_IMPLEMENT();
102  }
103
104  /**
105   * java.lang.Object is outside the scope of the CORBA standards and the write
106   * operation cannot be supported in a language-neutral way.
107   *
108   * @throws NO_IMPLEMENT always.
109   */
110  public void _write(OutputStream output)
111  {
112    throw new NO_IMPLEMENT();
113  }
114}