KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > team > internal > ccvs > core > ICVSRemoteFile


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.team.internal.ccvs.core;
12
13  
14 import java.io.InputStream JavaDoc;
15
16 import org.eclipse.core.runtime.IProgressMonitor;
17 import org.eclipse.team.core.TeamException;
18
19  /**
20   * This interface represents a file in a repository.
21   * Instances of this interface can be used to fetch the contents
22   * of the remote file.
23   *
24   * In the future, additional information should be available (tags, revisions, etc.)
25   *
26   * Clients are not expected to implement this interface.
27   */
28 public interface ICVSRemoteFile extends ICVSRemoteResource, ICVSFile {
29
30     /**
31      * Returns a stream over the contents of this remote element.
32      *
33      * @param progress a progress monitor to indicate the duration of the operation, or
34      * <code>null</code> if progress reporting is not required.
35      */
36     public InputStream JavaDoc getContents(IProgressMonitor progress) throws TeamException;
37     
38     /**
39      * Get the log entry for the revision the remote file represents.
40      * This method will return null until after the getContents(IProgressMonitor)
41      * method is called (i.e. the call to getContents also fetches the entry.
42      */
43     public ILogEntry getLogEntry(IProgressMonitor monitor) throws TeamException;
44     
45     /**
46      * Get all the log entries of the remote file
47      */
48     public ILogEntry[] getLogEntries(IProgressMonitor monitor) throws TeamException;
49     
50     /**
51      * Get the revision of the remote file (e.g. 1.1)
52      *
53      * The revision depends on any tagging associated with the remote parent used
54      * to access the file.
55      */
56     public String JavaDoc getRevision() throws TeamException;
57 }
58
59
Popular Tags