IBuildEntry


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.pde.core.build;
12  
13  import org.eclipse.core.runtime.CoreException;
14  import org.eclipse.pde.core.IWritable;
15  /**
16   * Jar entry represents one 'library=folder list' entry
17   * in plugin.jars file.
18   */
19  public interface IBuildEntry extends IWritable {
20      /**
21       * A property name for changes to the 'name' field.
22       */
23      public static final String   P_NAME = "name"; //$NON-NLS-1$
24      /**
25       * The prefix for any key denoting the source folders that
26       * should be compiled into a JAR.  The suffix will
27       * be the name of the JAR.
28       */
29      public static final String   JAR_PREFIX = "source."; //$NON-NLS-1$
30      /**
31       * The prefix for any key denoting output folders for a particular 
32       * JAR.  The suffix will be the name of the JAR.
33       */ 
34      public static final String   OUTPUT_PREFIX = "output."; //$NON-NLS-1$
35      /**
36       * The name of the key that lists all the folders and files
37       * to be included in the binary build.
38       */ 
39      public static final String   BIN_INCLUDES = "bin.includes"; //$NON-NLS-1$
40      /**
41       * The name of the key that lists all the folders and files
42       * to be included in the source build.
43       */ 
44      public static final String   SRC_INCLUDES = "src.includes"; //$NON-NLS-1$
45      /**
46       * The name of the key that declares extra library entries to be added
47       * to the class path at build time only..
48       */ 
49      public static final String   JARS_EXTRA_CLASSPATH = "jars.extra.classpath"; //$NON-NLS-1$
50      /**
51       * The name of the key that declares additional plug-in dependencies to augment development classpath
52       * 
53       * @since 3.2
54       */ 
55      public static final String   SECONDARY_DEPENDENCIES = "additional.bundles"; //$NON-NLS-1$
56      /**
57       * Adds the token to the list of token for this entry.
58       * This method will throw a CoreException if
59       * the model is not editable.
60       *
61       * @param token a name to be added to the list of tokens
62       */
63      void addToken(String   token) throws CoreException;
64      /**
65       * Returns a model that owns this entry
66       * @return build.properties model
67       */
68      IBuildModel getModel();
69      /**
70       * Returns the name of this entry.
71       * @return the entry name
72       */
73      String   getName();
74      /**
75       * Returns an array of tokens for this entry
76       * @return array of tokens
77       */
78      String  [] getTokens();
79  
80      /**
81       * Returns true if the provided token exists in this entry.
82       * @return true if the token exists in the entry
83       */
84      boolean contains(String   token);
85      /**
86       * Removes the token from the list of tokens for this entry.
87       * This method will throw a CoreException if
88       * the model is not editable.
89       *
90       * @param token a name to be removed from the list of tokens
91       */
92      void removeToken(String   token) throws CoreException;
93      /**
94       * Changes the name of the token without changing its
95       * position in the list. This method will throw
96       * a CoreException if the model is not editable.
97       *
98       * @param oldToken the old token name
99       * @param newToken the new token name
100      */
101     void renameToken(String   oldToken, String   newToken) throws CoreException;
102     /**
103      * Sets the name of this build entry. This
104      * method will throw a CoreException if
105      * model is not editable.
106      *
107      * @param name the new name for the entry
108      */
109     void setName(String   name) throws CoreException;
110 }
111
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags