IAbstractFile.java

/*
 * Copyright (C) 2008 The Android Open Source Project
 *
 * Licensed under the Eclipse Public License, Version 1.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.eclipse.org/org/documents/epl-v10.php
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.ide.eclipse.editors.resources.manager.files;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.CoreException;

import java.io.InputStream;

/**
 * A file.
 */
public interface IAbstractFile extends IAbstractResource {

    /**
     * Returns an {@link InputStream} object on the file content.
     * @throws CoreException
     */
    InputStream getContents() throws CoreException;

    /**
     * Returns the OS path of the file location.
     */
    String getOsLocation();

    /**
     * Returns the {@link IFile} object that the receiver could represent. Can be <code>null</code>
     */
    IFile getIFile();
}