Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
Copyright (c) 2000, 2010 IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html Contributors: IBM Corporation - initial API and implementation /
 
 package org.eclipse.jdt.core;
 
 import  org.eclipse.core.resources.IResource;
 import  org.eclipse.core.runtime.IProgressMonitor;
 import  org.eclipse.text.edits.TextEdit;
 import  org.eclipse.text.edits.UndoEdit;

A buffer contains the text contents of a resource. It is not language-specific. The contents may be in the process of being edited, differing from the actual contents of the underlying resource. A buffer has an owner, which is an IOpenable. If a buffer does not have an underlying resource, saving the buffer has no effect. Buffers can be read-only.

Note that java model operations that manipulate an IBuffer (for example, IType.createMethod(...)) ensures that the same line delimiter (either "\n" or "\r" or "\r\n") is used across the whole buffer. Thus these operations may change the line delimiter(s) included in the string to be append, or replaced. However implementers of this interface should be aware that other clients of IBuffer might not do such transformations beforehand.

This interface may be implemented by clients.

 
 public interface IBuffer {

Implementors of IBuffer can additionally implement IBuffer.ITextEditCapability. This adds the capability to apply text edits to the buffer and will be used by ICompilationUnit.applyTextEdit(TextEdit, IProgressMonitor).

This interface may be implemented by clients.

Since:
3.4
 
 public interface ITextEditCapability {
Applies a text edit to this underlying buffer.

Parameters:
edit the edit to apply
monitor the progress monitor to use or null if no progress should be reported
Returns:
the undo edit
Throws:
JavaModelException if this edit can not be applied to the buffer. Reasons include:
  • The provided edit can not be applied as there is a problem with the text edit locations (IJavaModelStatusConstants.BAD_TEXT_EDIT_LOCATION)}.
 
 	public UndoEdit applyTextEdit(TextEdit edit, IProgressMonitor monitorthrows JavaModelException;
 }


Adds the given listener for changes to this buffer. Has no effect if an identical listener is already registered or if the buffer is closed.

Parameters:
listener the listener of buffer changes
 
Appends the given character array to the contents of the buffer. This buffer will now have unsaved changes. Any client can append to the contents of the buffer, not just the owner of the buffer. Reports a buffer changed event.

Has no effect if this buffer is read-only or if the buffer is closed.

Parameters:
text the given character array to append to contents of the buffer
 
 public void append(char[] text);
Appends the given string to the contents of the buffer. This buffer will now have unsaved changes. Any client can append to the contents of the buffer, not just the owner of the buffer. Reports a buffer changed event.

Has no effect if this buffer is read-only or if the buffer is closed.

Parameters:
text the String to append to the contents of the buffer
 
 public void append(String text);
Closes the buffer. Any unsaved changes are lost. Reports a buffer changed event with a 0 offset and a 0 length. When this event is fired, the buffer should already be closed.

Further operations on the buffer are not allowed, except for close. If an attempt is made to close an already closed buffer, the second attempt has no effect.

public void close();
Returns the character at the given position in this buffer.

The returned value is undefined if the buffer is closed.

Parameters:
position a zero-based source offset in this buffer
Returns:
the character at the given position in this buffer
public char getChar(int position);
Returns the contents of this buffer as a character array, or null if the buffer has not been initialized.

Callers should make no assumption about whether the returned character array is or is not the genuine article or a copy. In other words, if the client wishes to change this array, they should make a copy. Likewise, if the client wishes to hang on to the array in its current state, they should make a copy.

The returned value is undefined if the buffer is closed.

Returns:
the characters contained in this buffer
public char[] getCharacters();
Returns the contents of this buffer as a String. Like all strings, the result is an immutable value object., It can also answer null if the buffer has not been initialized.

The returned value is undefined if the buffer is closed.

Returns:
the contents of this buffer as a String
Returns number of characters stored in this buffer.

The returned value is undefined if the buffer is closed.

Returns:
the number of characters in this buffer
public int getLength();
Returns the Java openable element owning of this buffer.

Returns:
the openable element owning this buffer
Returns the given range of text in this buffer.

The returned value is undefined if the buffer is closed.

Parameters:
offset the zero-based starting offset
length the number of characters to retrieve
Returns:
the given range of text in this buffer
Throws:
IndexOutOfBoundsException when buffer is out of synch
public String getText(int offsetint lengththrows IndexOutOfBoundsException;
Returns the underlying resource for which this buffer was opened, or null if this buffer was not opened on a resource.

Returns:
the underlying resource for this buffer, or null if none.
public IResource getUnderlyingResource();
Returns whether this buffer has been modified since it was opened or since it was last saved. If a buffer does not have an underlying resource, this method always returns true.

NOTE: when a buffer does not have unsaved changes, the model may decide to close it to claim some memory back. If the associated element needs to be reopened later on, its buffer factory will be requested to create a new buffer.

Returns:
a boolean indicating presence of unsaved changes (in the absence of any underlying resource, it will always return true).
public boolean hasUnsavedChanges();
Returns whether this buffer has been closed.

Returns:
a boolean indicating whether this buffer is closed.
public boolean isClosed();
Returns whether this buffer is read-only.

Returns:
a boolean indicating whether this buffer is read-only
public boolean isReadOnly();
Removes the given listener from this buffer. Has no effect if an identical listener is not registered or if the buffer is closed.

Parameters:
listener the listener
Replaces the given range of characters in this buffer with the given text. position and position + length must be in the range [0, getLength()]. length must not be negative.

Has no effect if this buffer is read-only or if the buffer is closed.

Parameters:
position the zero-based starting position of the affected text range in this buffer
length the length of the affected text range in this buffer
text the replacing text as a character array
public void replace(int positionint lengthchar[] text);
Replaces the given range of characters in this buffer with the given text. position and position + length must be in the range [0, getLength()]. length must not be negative.

Has no effect if this buffer is read-only or if the buffer is closed.

Parameters:
position the zero-based starting position of the affected text range in this buffer
length the length of the affected text range in this buffer
text the replacing text as a String
public void replace(int positionint lengthString text);
Saves the contents of this buffer to its underlying resource. If successful, this buffer will have no unsaved changes. The buffer is left open. Saving a buffer with no unsaved changes has no effect - the underlying resource is not changed. If the buffer does not have an underlying resource or is read-only, this has no effect.

The force parameter controls how this method deals with cases where the workbench is not completely in sync with the local file system. If false is specified, this method will only attempt to overwrite a corresponding file in the local file system provided it is in sync with the workbench. This option ensures there is no unintended data loss; it is the recommended setting. However, if true is specified, an attempt will be made to write a corresponding file in the local file system, overwriting any existing one if need be. In either case, if this method succeeds, the resource will be marked as being local (even if it wasn't before).

Has no effect if this buffer is read-only or if the buffer is closed.

Parameters:
progress the progress monitor to notify
force a boolean flag indicating how to deal with resource inconsistencies.
Throws:
JavaModelException if an error occurs writing the buffer to the underlying resource
See also:
org.eclipse.core.resources.IFile.setContents(java.io.InputStream, boolean, boolean, org.eclipse.core.runtime.IProgressMonitor)
public void save(IProgressMonitor progressboolean forcethrows JavaModelException;
Sets the contents of this buffer to the given character array. This buffer will now have unsaved changes. Any client can set the contents of the buffer, not just the owner of the buffer. Reports a buffer changed event.

Equivalent to replace(0,getLength(),contents).

Has no effect if this buffer is read-only or if the buffer is closed.

Parameters:
contents the new contents of this buffer as a character array
public void setContents(char[] contents);
Sets the contents of this buffer to the given String. This buffer will now have unsaved changes. Any client can set the contents of the buffer, not just the owner of the buffer. Reports a buffer changed event.

Equivalent to replace(0,getLength(),contents).

Has no effect if this buffer is read-only or if the buffer is closed.

Parameters:
contents the new contents of this buffer as a String
public void setContents(String contents);
New to GrepCode? Check out our FAQ X