KickJava   Java API By Example, From Geeks To Geeks.

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


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 org.eclipse.team.internal.ccvs.core.client.Command.LocalOption;
15
16  /**
17   * This interface represents a remote folder in a repository. It provides
18   * access to the members (remote files and folders) of a remote folder
19   *
20   * Clients are not expected to implement this interface.
21   */
22 public interface ICVSRemoteFolder extends ICVSRemoteResource, ICVSFolder {
23     
24     // This constant is the name of the folder at the root of a repository
25 public static final String JavaDoc REPOSITORY_ROOT_FOLDER_NAME = ""; //$NON-NLS-1$
26
27     /**
28      * Return the context of this handle. The returned tag can be a branch or
29      * version tag.
30      */
31     public CVSTag getTag();
32     
33     /**
34      * Return the local options that are used to determine how memebers are retrieved.
35      *
36      * Interesting options are:
37      * Checkout.ALIAS
38      * Command.DO_NOT_RECURSE
39      */
40     public LocalOption[] getLocalOptions();
41     
42     /**
43      * Indicates whether the remote folder can be expanded.
44      *
45      * This is a temporary (hopefully) means of indicating certain types of folders
46      * (i.e. module definitions) that are not expandable due to lack of mdoule expansion.
47      * They can still be checked out.
48      */
49     public boolean isExpandable();
50     
51     /**
52      * Indicates whether the remote folder is an actual remote folder is a
53      * module defined in the CVSROOT/modules file (or some other module
54      * definition).
55      */
56     public boolean isDefinedModule();
57 }
58
Popular Tags