KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > pde > core > IWritable


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.pde.core;
12 import java.io.PrintWriter JavaDoc;
13 /**
14  * Classes that implement this interface can participate in saving the model to
15  * the ASCII output stream using the provided writer.
16  *
17  * @since 2.0
18  */
19 public interface IWritable {
20     /**
21      * Writes the ASCII representation of the writable into the provider writer.
22      * The writable should use the provided indent to write the stream starting
23      * from the specified column number. Indent string should be written to the
24      * writer after every new line.
25      *
26      * @param indent
27      * a string that should be added after each new line to maintain
28      * desired horizontal alignment
29      * @param writer
30      * a writer to be used to write this object's textual
31      * representation
32      */
33     void write(String JavaDoc indent, PrintWriter JavaDoc writer);
34 }
35
Popular Tags