| /******************************************************************************* |
| * Copyright (c) 2000, 2005 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.internal.corext.refactoring.util; |
| |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.core.runtime.IPath; |
| import org.eclipse.core.runtime.NullProgressMonitor; |
| |
| import org.eclipse.core.resources.IResource; |
| |
| import org.eclipse.core.filebuffers.FileBuffers; |
| import org.eclipse.core.filebuffers.ITextFileBuffer; |
| |
| import org.eclipse.jdt.core.ICompilationUnit; |
| |
| import org.eclipse.jdt.internal.corext.Assert; |
| |
| /** |
| * Helper methods to deal with file buffers in refactorings. |
| */ |
| public final class RefactoringFileBuffers { |
| |
| /** |
| * Connects to and acquires a text file buffer for the specified compilation unit. |
| * <p> |
| * All text file buffers acquired by a call to {@link RefactoringFileBuffers#acquire(ICompilationUnit)} |
| * must be released using {@link RefactoringFileBuffers#release(ICompilationUnit)}. |
| * </p> |
| * |
| * @param unit the compilation unit to acquire a text file buffer for |
| * @return the text file buffer, or <code>null</code> if no buffer could be acquired |
| * @throws CoreException if no buffer could be acquired |
| */ |
| public static ITextFileBuffer acquire(final ICompilationUnit unit) throws CoreException { |
| Assert.isNotNull(unit); |
| final IResource resource= unit.getResource(); |
| if (resource != null && resource.getType() == IResource.FILE) { |
| final IPath path= resource.getFullPath(); |
| FileBuffers.getTextFileBufferManager().connect(path, new NullProgressMonitor()); |
| return FileBuffers.getTextFileBufferManager().getTextFileBuffer(path); |
| } |
| return null; |
| } |
| |
| /** |
| * Returns the text file buffer for the specified compilation unit. |
| * |
| * @param unit the compilation unit whose text file buffer to retrieve |
| * @return the associated text file buffer, or <code>null</code> if no text file buffer is managed for the compilation unit |
| */ |
| public static ITextFileBuffer getTextFileBuffer(final ICompilationUnit unit) { |
| Assert.isNotNull(unit); |
| final IResource resource= unit.getResource(); |
| if (resource == null || resource.getType() != IResource.FILE) |
| return null; |
| return FileBuffers.getTextFileBufferManager().getTextFileBuffer(resource.getFullPath()); |
| } |
| |
| /** |
| * Releases the text file buffer associated with the compilation unit. |
| * |
| * @param unit the compilation unit whose text file buffer has to be released |
| * @throws CoreException if the buffer could not be successfully released |
| */ |
| public static void release(final ICompilationUnit unit) throws CoreException { |
| Assert.isNotNull(unit); |
| final IResource resource= unit.getResource(); |
| if (resource != null && resource.getType() == IResource.FILE) |
| FileBuffers.getTextFileBufferManager().disconnect(resource.getFullPath(), new NullProgressMonitor()); |
| } |
| |
| private RefactoringFileBuffers() { |
| // Not for instantiation |
| } |
| } |