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

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2003 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v10.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  *
  19  * @since 2.0
  20  */
  21 public interface IBufferFactory {
  22
  23         /**
  24          * Creates a buffer for the given owner. The new buffer will be initialized
  25          * with the contents of the owner if and only if it was not already
  26          * initialized by the factory (a buffer is uninitialized if its content is
  27          * <code>null</code>).
  28          *
  29          * @param owner
  30          *            the owner of the buffer
  31          * @see IBuffer
  32          */
  33         IBuffer createBuffer(IOpenable owner);
  34 }