org.netbeans.spi.editor.guards.support

Class AbstractGuardedSectionsProvider

java.lang.Object

org.netbeans.spi.editor.guards.support.AbstractGuardedSectionsProvider

All Implemented Interfaces:

GuardedSectionsProvider

public abstract class AbstractGuardedSectionsProvider
extends Object
implements GuardedSectionsProvider

The helper class that simplifies writing particular GuardedSectionsProvider implementations. Subclasses have to implement just AbstractGuardedSectionsProvider.readSections(char[]) and AbstractGuardedSectionsProvider.writeSections(java.util.List<org.netbeans.api.editor.guards.GuardedSection>, char[]) methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractGuardedSectionsProvider.Result

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGuardedSectionsProvider(GuardedEditorSupport editor) Creates an AbstractGuardedSectionsProvider.
protected	AbstractGuardedSectionsProvider(GuardedEditorSupport editor, boolean useReadersWritersOnSet) Creates an AbstractGuardedSectionsProvider.

Method Summary

Modifier and Type	Method and Description
Reader	createGuardedReader(InputStream stream, Charset charset) Creates a reader able to read persisted sections.
Writer	createGuardedWriter(OutputStream stream, Charset charset) Creates a writer able to write persisted sections.
InteriorSection	createInteriorSection(String name, int headerBegin, int headerEnd, int footerBegin, int footerEnd) Creates an interior section object to represent section read by the readSections.
SimpleSection	createSimpleSection(String name, int begin, int end) Creates a simple section object to represent section read by the readSections.
abstract AbstractGuardedSectionsProvider.Result	readSections(char[] content) This should be implemented to extract guarded sections out of the passed content.
abstract char[]	writeSections(List<GuardedSection> sections, char[] content) This should be implemented to persist a list of guarded sections inside the passed content.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractGuardedSectionsProvider

protected AbstractGuardedSectionsProvider(GuardedEditorSupport editor)

Creates an AbstractGuardedSectionsProvider.

Parameters:

editor - an editor abstraction

AbstractGuardedSectionsProvider

protected AbstractGuardedSectionsProvider(GuardedEditorSupport editor,
                                          boolean useReadersWritersOnSet)

Creates an AbstractGuardedSectionsProvider.

Parameters:

editor - an editor abstraction

useReadersWritersOnSet - if readers and writers should be used when the content of the guarded section's text is set

Since:

1.20

Method Detail

createGuardedReader

public final Reader createGuardedReader(InputStream stream,
                                        Charset charset)

Description copied from interface: GuardedSectionsProvider

Creates a reader able to read persisted sections.

Specified by:

createGuardedReader in interface GuardedSectionsProvider

Parameters:

stream - stream containing persisted sections

charset - charset to decode read bytes, null implies the system default charset.

Returns:

the reader

createGuardedWriter

public Writer createGuardedWriter(OutputStream stream,
                                  Charset charset)

Description copied from interface: GuardedSectionsProvider

Creates a writer able to write persisted sections.

Specified by:

createGuardedWriter in interface GuardedSectionsProvider

Parameters:

stream - stream where the output should be written

charset - charset used by the writer

Returns:

the writer

writeSections

public abstract char[] writeSections(List<GuardedSection> sections,
                                     char[] content)

This should be implemented to persist a list of guarded sections inside the passed content.

Parameters:

sections - guarded sections to persist

content - content

Returns:

content including guarded sections

readSections

public abstract AbstractGuardedSectionsProvider.Result readSections(char[] content)

This should be implemented to extract guarded sections out of the passed content.

Parameters:

content - content including guarded sections

Returns:

the content that will be presented to users and the list of guarded sections

createSimpleSection

public final SimpleSection createSimpleSection(String name,
                                               int begin,
                                               int end)
                                        throws BadLocationException

Creates a simple section object to represent section read by the readSections.

Parameters:

name - the section name

begin - the start offset

end - the end offset

Returns:

the simple section instance

Throws:

BadLocationException - if the given position does not represent a valid location in the associated document

createInteriorSection

public final InteriorSection createInteriorSection(String name,
                                                   int headerBegin,
                                                   int headerEnd,
                                                   int footerBegin,
                                                   int footerEnd)
                                            throws BadLocationException

Creates an interior section object to represent section read by the readSections.

Parameters:

name - the section name

headerBegin - begin the start offset of the first guarded part

headerEnd - end the end offset of the first guarded part

footerBegin - begin the start offset of the second guarded part

footerEnd - end the end offset of the second guarded part

Returns:

the interior section object

Throws:

BadLocationException - if the given position does not represent a valid location in the associated document