oracle.javatools.buffer

Class GuardedTextBuffer

java.lang.Object

oracle.javatools.buffer.ReadTextBufferDecorator

oracle.javatools.buffer.TextBufferDecorator

oracle.javatools.buffer.GuardedTextBuffer

All Implemented Interfaces:

ReadTextBuffer, TextBuffer

public class GuardedTextBuffer
extends TextBufferDecorator

A TextBuffer that decorates another TextBuffer to prevent modification in certain 'guarded' regions.

A range of offsets can be marked as guarded or unguarded via the guard and unguard methods. The guard can be turned on or off via setGuardActive().

Any attempt to modify a guarded section, when the guard is active, will result in a GuardedException.

Field Summary

Fields inherited from class oracle.javatools.buffer.TextBufferDecorator

_forwarder, _tbuffer

Fields inherited from class oracle.javatools.buffer.ReadTextBufferDecorator

_rbuffer

Fields inherited from interface oracle.javatools.buffer.TextBuffer

EOL_CR, EOL_CRLF, EOL_LF, EOL_MACINTOSH, EOL_UNIX, EOL_WINDOWS, READ_ONLY, WRITABLE

Fields inherited from interface oracle.javatools.buffer.ReadTextBuffer

LOCK_STATUS_NONE, LOCK_STATUS_READ, LOCK_STATUS_UNSUPPORTED, LOCK_STATUS_WRITE

Constructor Summary

Constructors

Constructor and Description
GuardedTextBuffer(TextBuffer textBuffer) Create a guarded text buffer by wrapping a TextBuffer.
GuardedTextBuffer(TextBuffer textBuffer, boolean forwardListeners) Create a guarded text buffer by wrapping a TextBuffer.

Method Summary

Methods

Modifier and Type	Method and Description
void	addGuardedTextBufferListener(GuardedTextBufferListener listener) Add a listener to be notified when sections become guarded and unguarded.
int	findInsertableOffset(int offset, int count, boolean admitInsertToGuardedBeginning) Finds first insertable unguarded offset for specified range.
java.util.List<OffsetRegion>	getRegions()
void	guard(int offset, int length) Guard a section of the buffer.
javax.swing.undo.UndoableEdit	insert(int offset, char[] data) Inserts the indicated data into the text buffer at the given offset.
javax.swing.undo.UndoableEdit	insert(int offset, java.io.Reader reader) Inserts the data from a Reader instance into the text buffer at the given offset.
boolean	isGuardActive()
boolean	isOffsetGuarded(int offset)
boolean	isOffsetRangeGuarded(int offset, int count)
void	read(java.io.Reader reader) Replaces the current contents of the text buffer with the data from a reader instance.
javax.swing.undo.UndoableEdit	remove(int offset, int count) Removes a range of data from the text buffer.
void	removeGuardedTextBufferListener(GuardedTextBufferListener listener)
javax.swing.undo.UndoableEdit	removeToEnd(int offset) Removes data from the text buffer starting at the given offset to the end of the buffer.
void	setGuardActive(boolean isGuardActive) Turn the guard on or off.
void	unguard(int offset, int length) Stop guarding a section of the buffer.

Methods inherited from class oracle.javatools.buffer.TextBufferDecorator

addOffsetMark, addOffsetMark, addTextBufferListener, addWriteLockRequestListener, append, beginEdit, clearModified, endEdit, getChangeId, getEOLType, getLineMap, getPlatformEOLType, getTextBuffer, isModified, isReadOnly, removeOffsetMark, removeTextBufferListener, removeWriteLockRequestListener, setEOLType, setReadOnly, setTextBuffer, tryWriteLock, write, write, writeLock, writeLock, writeLockInterruptibly, writeUnlock

Methods inherited from class oracle.javatools.buffer.ReadTextBufferDecorator

getChar, getChars, getLength, getLockStatus, getString, getText, readLock, readLockInterruptibly, readUnlock, tryReadLock

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.javatools.buffer.ReadTextBuffer

getChar, getChars, getLength, getLockStatus, getString, getText, readLock, readLockInterruptibly, readUnlock, tryReadLock

Constructor Detail

GuardedTextBuffer

public GuardedTextBuffer(TextBuffer textBuffer)

Create a guarded text buffer by wrapping a TextBuffer. By default does not listen to the target buffer, use the other constructor if needed.

Parameters:

textBuffer -

GuardedTextBuffer

public GuardedTextBuffer(TextBuffer textBuffer,
                 boolean forwardListeners)

Create a guarded text buffer by wrapping a TextBuffer.

Parameters:

textBuffer -

forwardListeners - whether listeners attached to GuardedTextBuffer should be attached to the delegate buffer, use true if you don't listen to the delegate buffer directly

Method Detail

guard

public void guard(int offset,
         int length)

Guard a section of the buffer. Any modification attempts in this section when the guard is active will result in a GuardedException

Parameters:

offset -

length -

unguard

public void unguard(int offset,
           int length)

Stop guarding a section of the buffer. Attempts to modify the given range will not result in GuardedException.

Parameters:

offset -

length -

isOffsetGuarded

public boolean isOffsetGuarded(int offset)

Parameters:

offset -

Returns:

true if the given offset is currently guarded

isOffsetRangeGuarded

public boolean isOffsetRangeGuarded(int offset,
                           int count)

Parameters:

offset -

count -

Returns:

true if any offset in the given range is currently guarded

findInsertableOffset

public int findInsertableOffset(int offset,
                       int count,
                       boolean admitInsertToGuardedBeginning)

Finds first insertable unguarded offset for specified range. Pass true to admitInsertToGuardedBeginning if insert should be admissible at the beginning of a guarded block - possibility to insert between two adjacent guarded blocks. See insert(int, char[]) implementation.

Parameters:

offset - Start of offset

count - Length of offset

admitInsertToGuardedBeginning - Should be insert at beginning of guarded block admissible?

Returns:

First unguarded index within specified range if there is any, otherwise returns -1.

getRegions

public java.util.List<OffsetRegion> getRegions()

Returns:

the list of regions currently marked as guarded.

setGuardActive

public void setGuardActive(boolean isGuardActive)

Turn the guard on or off. When on any attempted change to the text buffer in a guarded section will result in a GuardedException being thrown.

Parameters:

isGuardActive -

isGuardActive

public boolean isGuardActive()

Returns:

if the guard is currently active.

insert

public javax.swing.undo.UndoableEdit insert(int offset,
                                   char[] data)
                                     throws java.lang.IndexOutOfBoundsException,
                                            ReadOnlyException

Description copied from class: TextBufferDecorator

Inserts the indicated data into the text buffer at the given offset. This causes all registered TextBufferListeners to be notified by calling insertUpdate(). This will return an UndoableEdit representing this insert change unless a compound edit is in progress in which case null is returned.

Specified by:

insert in interface TextBuffer

Overrides:

insert in class TextBufferDecorator

Parameters:

offset - the offset at which to insert the new data

data - the text to insert

Returns:

the UndoableEdit representing the insert performed if a compound edit is not in progress

Throws:

java.lang.IndexOutOfBoundsException - if offset is invalid

ReadOnlyException - if the buffer is in read only mode

See Also:

TextBuffer.beginEdit(), TextBuffer.endEdit(), TextBuffer.addTextBufferListener(oracle.javatools.buffer.TextBufferListener), TextBuffer.removeTextBufferListener(oracle.javatools.buffer.TextBufferListener)

insert

public javax.swing.undo.UndoableEdit insert(int offset,
                                   java.io.Reader reader)
                                     throws java.lang.IndexOutOfBoundsException,
                                            java.io.IOException,
                                            ReadOnlyException

Description copied from class: TextBufferDecorator

Inserts the data from a Reader instance into the text buffer at the given offset. This causes all registered TextBufferListeners to be notified by calling insertUpdate(). This will return an UndoableEdit representing this insert change unless a compound edit is in progress in which case null is returned.

Specified by:

insert in interface TextBuffer

Overrides:

insert in class TextBufferDecorator

Parameters:

offset - the offset at which to insert the new data

reader - a Reader instance from which to read text data

Returns:

the UndoableEdit representing the insert performed if a compound edit is not in progress

Throws:

java.lang.IndexOutOfBoundsException - if offset is invalid

java.io.IOException - as thrown by the stream if an error occurs while reading data

ReadOnlyException - if the buffer is in read only mode

See Also:

TextBuffer.beginEdit(), TextBuffer.endEdit(), TextBuffer.addTextBufferListener(oracle.javatools.buffer.TextBufferListener), TextBuffer.removeTextBufferListener(oracle.javatools.buffer.TextBufferListener)

remove

public javax.swing.undo.UndoableEdit remove(int offset,
                                   int count)
                                     throws java.lang.IndexOutOfBoundsException,
                                            ReadOnlyException

Description copied from class: TextBufferDecorator

Removes a range of data from the text buffer. This causes all registered TextBufferListeners to be notified by calling removeUpdate(). This will return an UndoableEdit representing this removal change unless a compound edit is in progress in which case null is returned.

Specified by:

remove in interface TextBuffer

Overrides:

remove in class TextBufferDecorator

Parameters:

offset - the offset at which to remove data

count - number of characters to remove

Returns:

the UndoableEdit representing the remove performed if a compound edit is not in progress

Throws:

java.lang.IndexOutOfBoundsException - if offset or count is invalid

ReadOnlyException - if the buffer is in read only mode

See Also:

TextBuffer.beginEdit(), TextBuffer.endEdit()

removeToEnd

public javax.swing.undo.UndoableEdit removeToEnd(int offset)
                                          throws java.lang.IndexOutOfBoundsException,
                                                 ReadOnlyException

Description copied from class: TextBufferDecorator

Removes data from the text buffer starting at the given offset to the end of the buffer. This is a convenience routine which simply calls remove in turn. As with the remove, all registered TextBufferListeners will receive a removeUpdate notification. The UndoableEdit representing this removal will be returned unless a compound edit is in progress.

Specified by:

removeToEnd in interface TextBuffer

Overrides:

removeToEnd in class TextBufferDecorator

Parameters:

offset - the offset at which to remove data

Returns:

the UndoableEdit representing the remove performed if a compound edit is not in progress

Throws:

java.lang.IndexOutOfBoundsException - if offset is invalid

ReadOnlyException - if the buffer is in read only mode

See Also:

TextBuffer.remove(int, int), TextBuffer.beginEdit(), TextBuffer.endEdit()

read

public void read(java.io.Reader reader)
          throws java.io.IOException

Description copied from class: TextBufferDecorator

Replaces the current contents of the text buffer with the data from a reader instance. Previous contents are discarded. Currently this operation is not undoable. If an error occurs while reading the file, the contents of the file will simply be empty. This operation cannot be performed while a compound edit is in progress.

Note that this call will reset the read-only status of the text buffer back to WRITABLE.

Specified by:

read in interface TextBuffer

Overrides:

read in class TextBufferDecorator

Parameters:

reader - a Reader instance from which to read text data

Throws:

java.io.IOException - as thrown by the stream if an error occurs while reading data

addGuardedTextBufferListener

public void addGuardedTextBufferListener(GuardedTextBufferListener listener)

Add a listener to be notified when sections become guarded and unguarded.

Parameters:

listener -

removeGuardedTextBufferListener

public void removeGuardedTextBufferListener(GuardedTextBufferListener listener)