Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: bf65ae957fc592f2ec58726dffe48dc35ca36cce (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/*****************************************************************************
 * Copyright (c) 2011 CEA LIST.
 *
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *  Vincent Lorenzo (CEA LIST) vincent.lorenzo@cea.fr - Initial API and implementation
 *  Camille Letavernier (CEA LIST) camille.letavernier@cea.fr
 *
 *****************************************************************************/
package org.eclipse.papyrus.eclipse.project.editors.interfaces;

/**
 *
 * Editor for the build.properties
 * 
 * @noimplement This interface is not intended to be implemented by clients.
 * @noextend This interface is not intended to be extended by clients.
 */
public interface IBuildEditor extends IFileEditor {

	/**
	 * key for the bin
	 *
	 * @Deprecated The build key should be specified for each IBuildEditor instance
	 */
	@Deprecated
	public final static String BUILD_KEY = "bin.includes"; //$NON-NLS-1$

	/** key for the source folders */
	public final static String SOURCE_FOLDER_KEY = "source.."; //$NON-NLS-1$

	/** key for the bin folders */
	public static final String BIN_KEY = "bin.."; //$NON-NLS-1$

	/** name of the file build.properties */
	public static final String BUILD_PROPERTIES_FILE = "build.properties"; //$NON-NLS-1$

	/**
	 * The build key for the Eclipse Binary Build
	 */
	public static final String BINARY_BUILD = "bin.includes";

	/**
	 * The build key for the Eclipse Source Build
	 */
	public static final String SOURCE_BUILD = "src.includes";

	/** the method to register a new source folder */
	public void registerSourceFolder(String string);

	/** registers a new bin folder */
	public void registerBinFolder(String binFolder);

	/** the method to add an element to the build */
	public void addToBuild(final String path);

	/** removes the given path from the build */
	public void removeFromBuild(final String path);

	/**
	 * Returns <code>true</code> if the folder is registered as a Source Folder
	 *
	 * @param path
	 *            the path of a source folder
	 * @return
	 *         <code>true</code> if the folder is registered
	 */
	public boolean isRegisteredSourceFolder(final String path);

	/**
	 * Returns <code>true</code> if the folder is registered as a Bin Folder
	 *
	 * @param path
	 *            the path of a bin folder
	 * @return
	 *         <code>true</code> if the folder is registered
	 */
	public boolean isRegisteredBinFolder(final String binFolder);

	/**
	 * Returns all the registered source folders
	 *
	 * @return
	 * 		all the registered source folders
	 */
	public String[] getSourceFolders();

	/**
	 * Returns all the files added to the build
	 *
	 * @return
	 * 		all the files added to the build
	 */
	public String[] getElementsInBuild();
}

Back to the top