net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IBufferFactory.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2001, 2002 International Business Machines Corp. and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v0.5
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v05.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  ******************************************************************************/
  11 package net.sourceforge.phpdt.core;
  12
  13 /**
  14  * A factory that creates <code>IBuffer</code>s for openables.
  15  * <p>
  16  * This interface may be implemented by clients.
  17  * </p>
  18  * @since 2.0
  19  */
  20 public interface IBufferFactory {
  21
  22         /**
  23          * Creates a buffer for the given owner.
  24          * The new buffer will be initialized with the contents of the owner
  25          * if and only if it was not already initialized by the factory (a buffer is uninitialized if
  26          * its content is <code>null</code>).
  27          *
  28          * @param owner the owner of the buffer
  29          * @see IBuffer
  30          */
  31         IBuffer createBuffer(IOpenable owner);
  32 }
  33