GuardedSectionsProvider (Editor Guarded Sections) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.guards/0 0.1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.spi.editor.guards
Interface GuardedSectionsProvider

All Known Implementing Classes:: AbstractGuardedSectionsProvider

public interface GuardedSectionsProvider

Subclasses should be able to read content containing guarded section marks and vice versa. You should subclass AbstractGuardedSectionsProvider. Use this interface in case you load or save the Document.

Method Summary

Reader createGuardedReader(InputStream stream, String encoding)
Creates a reader able to read persisted sections.

Writer createGuardedWriter(OutputStream stream, String encoding)
Creates a writer able to write persisted sections.

Method Summary
`Reader`	`createGuardedReader(InputStream stream, String encoding)` Creates a reader able to read persisted sections.
`Writer`	`createGuardedWriter(OutputStream stream, String encoding)` Creates a writer able to write persisted sections.

Method Detail

createGuardedReader

Reader createGuardedReader(InputStream stream,
                           String encoding)
                           throws UnsupportedEncodingException

Creates a reader able to read persisted sections.

Parameters:: stream - stream containing persisted sections; encoding - encoding to decode read bytes
Returns:: the reader
Throws:: if - the encoding is not supported; UnsupportedEncodingException

createGuardedWriter

Writer createGuardedWriter(OutputStream stream,
                           String encoding)
                           throws UnsupportedEncodingException

Creates a writer able to write persisted sections.

Parameters:: stream - stream where the output should be written; encoding - encoding used by the writer
Returns:: the writer
Throws:: if - the encoding is not supported; UnsupportedEncodingException