GuardedSectionsProvider


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.spi.editor.guards;
21  
22  import java.io.InputStream  ;
23  import java.io.OutputStream  ;
24  import java.io.Reader  ;
25  import java.io.UnsupportedEncodingException  ;
26  import java.io.Writer  ;
27  import org.netbeans.spi.editor.guards.support.AbstractGuardedSectionsProvider;
28  
29  /**
30   * Subclasses should be able to read content containing guarded section marks 
31   * and vice versa. You should subclass {@link AbstractGuardedSectionsProvider}.
32   * Use this interface in case you load or save the {@link javax.swing.text.Document}.
33   * @author Jan Pokorsky
34   */
35  public interface GuardedSectionsProvider {
36      
37      /**
38       * Creates a reader able to read persisted sections.
39       * @param stream stream containing persisted sections
40       * @param encoding encoding to decode read bytes 
41       * @return the reader
42       * @throws if the encoding is not supported
43       */
44      Reader   createGuardedReader(InputStream   stream, String   encoding) throws UnsupportedEncodingException  ;
45  
46      /**
47       * Creates a writer able to write persisted sections.
48       * @param stream stream where the output should be written
49       * @param encoding encoding used by the writer
50       * @return the writer
51       * @throws if the encoding is not supported
52       */
53      Writer   createGuardedWriter(OutputStream   stream, String   encoding) throws UnsupportedEncodingException  ;
54      
55  }
56
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags