shared/api/src/main/java/org/apache/sling/ide/sync/content/WorkspaceFile.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
 *
 * 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 org.apache.sling.ide.sync.content;

import java.io.IOException;
import java.io.InputStream;

/**
 * Represents a local file, <tt>i.e.</tt> present in the local workspace
 */
public interface WorkspaceFile extends WorkspaceResource {

    /**
     * Returns the contents of the file
     * 
     * @throws IOException I/O errors
     * @return the contents of the file
     */
    InputStream getContents() throws IOException;

    /**
     * Returns the parent of this file
     * 
     * @return the parent of this file
     */
    WorkspaceDirectory getParent();

}