| /******************************************************************************* |
| * Copyright (c) 2006 IBM Corporation and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.team.internal.ui; |
| |
| import java.io.InputStream; |
| |
| import org.eclipse.compare.CompareUI; |
| import org.eclipse.compare.IEncodedStreamContentAccessor; |
| import org.eclipse.compare.ISharedDocumentAdapter; |
| import org.eclipse.compare.ITypedElement; |
| import org.eclipse.compare.SharedDocumentAdapter; |
| import org.eclipse.core.resources.IEncodedStorage; |
| import org.eclipse.core.resources.IStorage; |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.core.runtime.IAdaptable; |
| import org.eclipse.core.runtime.IProgressMonitor; |
| import org.eclipse.core.runtime.NullProgressMonitor; |
| import org.eclipse.core.runtime.Platform; |
| import org.eclipse.jface.text.IDocument; |
| import org.eclipse.swt.graphics.Image; |
| import org.eclipse.team.core.TeamException; |
| import org.eclipse.ui.IEditorInput; |
| import org.eclipse.ui.texteditor.IDocumentProvider; |
| |
| public abstract class StorageTypedElement implements ITypedElement, IEncodedStreamContentAccessor, IAdaptable { |
| |
| private IStorage bufferedContents; |
| private final String localEncoding; |
| private ISharedDocumentAdapter sharedDocumentAdapter; |
| |
| public StorageTypedElement(String localEncoding){ |
| this.localEncoding = localEncoding; |
| } |
| |
| @Override |
| public InputStream getContents() throws CoreException { |
| if (bufferedContents == null) { |
| cacheContents(new NullProgressMonitor()); |
| } |
| if (bufferedContents != null) { |
| return bufferedContents.getContents(); |
| } |
| return null; |
| } |
| |
| /** |
| * Cache the contents for the remote resource in a local buffer. |
| * This method should be invoked before {@link #getContents()} |
| * to ensure that a round trip is not made in that method. |
| * @param monitor a progress monitor. |
| * @throws CoreException |
| */ |
| public void cacheContents(IProgressMonitor monitor) throws CoreException { |
| bufferedContents = fetchContents(monitor); |
| } |
| |
| /** |
| * Returns an IStorage for the element. |
| * @param monitor |
| * @return a storage |
| * @throws TeamException |
| */ |
| abstract protected IStorage fetchContents(IProgressMonitor monitor) throws CoreException; |
| |
| /** |
| * Return the {@link IStorage} that has been buffered for this element. |
| * @return the buffered storage |
| */ |
| public IStorage getBufferedStorage() { |
| return bufferedContents; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.compare.ITypedElement#getImage() |
| */ |
| @Override |
| public Image getImage() { |
| return CompareUI.getImage(getType()); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.compare.ITypedElement#getType() |
| */ |
| @Override |
| public String getType() { |
| String name = getName(); |
| if (name != null) { |
| int index = name.lastIndexOf('.'); |
| if (index == -1) |
| return ""; //$NON-NLS-1$ |
| if (index == (name.length() - 1)) |
| return ""; //$NON-NLS-1$ |
| return name.substring(index + 1); |
| } |
| return ITypedElement.FOLDER_TYPE; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.compare.IEncodedStreamContentAccessor#getCharset() |
| */ |
| @Override |
| public String getCharset() throws CoreException { |
| if (localEncoding != null) |
| return localEncoding; |
| if (bufferedContents == null) { |
| cacheContents(new NullProgressMonitor()); |
| } |
| if (bufferedContents instanceof IEncodedStorage) { |
| String charset = ((IEncodedStorage)bufferedContents).getCharset(); |
| return charset; |
| } |
| return null; |
| } |
| |
| @SuppressWarnings("unchecked") |
| @Override |
| public <T> T getAdapter(Class<T> adapter) { |
| if (adapter == ISharedDocumentAdapter.class) { |
| synchronized (this) { |
| if (sharedDocumentAdapter == null) |
| sharedDocumentAdapter = new SharedDocumentAdapter() { |
| @Override |
| public IEditorInput getDocumentKey(Object element) { |
| return StorageTypedElement.this.getDocumentKey(element); |
| } |
| @Override |
| public void flushDocument(IDocumentProvider provider, |
| IEditorInput documentKey, IDocument document, |
| boolean overwrite) |
| throws CoreException { |
| // The document is read-only |
| } |
| }; |
| return (T) sharedDocumentAdapter; |
| } |
| } |
| return Platform.getAdapterManager().getAdapter(this, adapter); |
| } |
| |
| /** |
| * Method called from the shared document adapter to get the document key. |
| * @param element the element |
| * @return the document key |
| */ |
| protected abstract IEditorInput getDocumentKey(Object element); |
| |
| public String getLocalEncoding() { |
| return localEncoding; |
| } |
| |
| } |