Source for gnu.javax.net.ssl.provider.Builder

   1: /* Builder.java -- builder interface for protocol objects.
   2:    Copyright (C) 2006  Free Software Foundation, Inc.
   3: 
   4: This file is a part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2 of the License, or (at
   9: your option) any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; if not, write to the Free Software
  18: Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  19: USA
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package gnu.javax.net.ssl.provider;
  40: 
  41: import java.nio.ByteBuffer;
  42: 
  43: /**
  44:  * The base interface for classes that build SSL protocol objects. The
  45:  * general contract for Builder implementations is that they maintain a
  46:  * buffer that grows to fit the object being built; the allocated size of
  47:  * this buffer may be larger than the built object needs, but the general
  48:  * effort will be not to allocate too large a buffer.
  49:  *
  50:  * <p>Once the object is built, through various <em>setters</em> for
  51:  * the object's attributes, the final buffer may be retrieved with the
  52:  * {@link #buffer()} method.
  53:  *
  54:  * @author Casey Marshall (csm@gnu.org)
  55:  */
  56: public interface Builder extends Constructed
  57: {
  58:   /**
  59:    * Returns the final buffer, possibly containing the built object. The
  60:    * returned buffer will be "trimmed" to size: its position will be zero,
  61:    * and its limit and capacity set to the length of the built object.
  62:    *
  63:    * @return The underlying buffer.
  64:    */
  65:   ByteBuffer buffer();
  66: }