net.grinder.console.editor

Interface Buffer

public interface Buffer

Buffer state.

Author:

Philip Aston

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Buffer.Type Buffer type.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(BufferImplementation.Listener listener) Add a new listener.
String	getDisplayName() Return display name of buffer.
File	getFile() Return the buffer's associated file.
TextSource	getTextSource() Return the buffer's TextSource.
Buffer.Type	getType() Get the type of the buffer.
boolean	isDirty() Return whether the buffer's text has been changed since the last save.
boolean	isUpToDate() Return whether the file has been independently modified since the last save.
void	load() Update the text source from the file.
void	save() Update the buffer's file from the text source.
void	save(File file) Update a file from the text source and, if successful, associate the buffer with the new file.
String	toString() Useful for debugging.

Method Detail

getTextSource

TextSource getTextSource()

Return the buffer's TextSource.

Returns:

The text source.

load

void load()
          throws DisplayMessageConsoleException,
                 EditorException

Update the text source from the file.

Throws:

DisplayMessageConsoleException - If the file could not be read from.

EditorException - If an unexpected problem occurs.

save

void save()
          throws DisplayMessageConsoleException,
                 EditorException

Update the buffer's file from the text source.

Throws:

DisplayMessageConsoleException - If the file could not be written to.

EditorException - If an unexpected problem occurs.

save

void save(File file)
          throws DisplayMessageConsoleException

Update a file from the text source and, if successful, associate the buffer with the new file.

Parameters:

file - The file.

Throws:

DisplayMessageConsoleException - If the file could not be written to.

isDirty

boolean isDirty()

Return whether the buffer's text has been changed since the last save.

Returns:

true => the text has changed.

getFile

File getFile()

Return the buffer's associated file.

Returns:

The file. null if there is no associated file.

isUpToDate

boolean isUpToDate()

Return whether the file has been independently modified since the last save.

Returns:

true => the file has changed independently of the buffer.

getType

Buffer.Type getType()

Get the type of the buffer.

Returns:

The buffer's type.

getDisplayName

String getDisplayName()

Return display name of buffer.

Returns:

The buffer's name.

toString

String toString()

Useful for debugging.

Overrides:

toString in class Object

Returns:

Description of the Buffer.

addListener

void addListener(BufferImplementation.Listener listener)

Add a new listener.

Parameters:

listener - The listener.