| /******************************************************************************* |
| * Copyright (c) 2007, 2008 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.core.filebuffers; |
| |
| import org.eclipse.core.runtime.IPath; |
| |
| |
| /** |
| * Type-safe enum of the available location kinds. |
| * |
| * @since 3.3 |
| * @noinstantiate This class is not intended to be instantiated by clients. |
| */ |
| public final class LocationKind { |
| |
| /** |
| * The corresponding argument is a location |
| * in a file system. |
| * <p> |
| * <strong>Note:</strong> File buffers that are |
| * connected using a file store will not be found. |
| * </p> |
| * |
| * @see IFileBufferManager#connectFileStore(org.eclipse.core.filesystem.IFileStore, org.eclipse.core.runtime.IProgressMonitor) |
| */ |
| public static final LocationKind LOCATION= new LocationKind("location"); //$NON-NLS-1$ |
| |
| /** |
| * The corresponding argument is the full path |
| * of an {@link org.eclipse.core.resources.IFile}. |
| * |
| * @see org.eclipse.core.resources.IFile#getFullPath() |
| */ |
| public static final LocationKind IFILE= new LocationKind("IFile"); //$NON-NLS-1$ |
| |
| /** |
| * Tells to normalize the corresponding argument according |
| * to {@link FileBuffers#normalizeLocation(IPath)}. |
| * <p> |
| * <strong>Note:</strong>: If the normalized path is not in the |
| * workspace then a file buffer that might be connected using |
| * a file store will not be found. |
| * </p> |
| * |
| * @see IFileBufferManager#connectFileStore(org.eclipse.core.filesystem.IFileStore, org.eclipse.core.runtime.IProgressMonitor) |
| */ |
| public static final LocationKind NORMALIZE= new LocationKind("normalize"); //$NON-NLS-1$ |
| |
| |
| private final String fName; |
| |
| LocationKind(String name) { |
| fName= name; |
| } |
| |
| @Override |
| public String toString() { |
| return fName; |
| } |
| } |