Package org.eclipse.pde.core.build
Interface IBuildEntry
- All Superinterfaces:
IWritable
Jar entry represents one 'library=folder list' entry
in plugin.jars file.
- Restriction:
- This interface is not intended to be implemented by clients.
- Restriction:
- This interface is not intended to be extended by clients.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe name of the key that lists all the folders and files to be included in the binary build.static final StringThe prefix for any key denoting the source folders that should be compiled into a JAR.static final StringThe name of the key that declares extra library entries to be added to the class path at build time only..static final StringThe prefix for any key denoting output folders for a particular JAR.static final StringA property name for changes to the 'name' field.static final StringThe name of the key that declares additional plug-in dependencies to augment development classpathstatic final StringThe name of the key that lists all the folders and files to be included in the source build. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds the token to the list of token for this entry.booleanReturns true if the provided token exists in this entry.getModel()Returns a model that owns this entrygetName()Returns the name of this entry.String[]Returns an array of tokens for this entryvoidremoveToken(String token) Removes the token from the list of tokens for this entry.voidrenameToken(String oldToken, String newToken) Changes the name of the token without changing its position in the list.voidSets the name of this build entry.
-
Field Details
-
P_NAME
A property name for changes to the 'name' field.- See Also:
-
JAR_PREFIX
The prefix for any key denoting the source folders that should be compiled into a JAR. The suffix will be the name of the JAR.- See Also:
-
OUTPUT_PREFIX
The prefix for any key denoting output folders for a particular JAR. The suffix will be the name of the JAR.- See Also:
-
BIN_INCLUDES
The name of the key that lists all the folders and files to be included in the binary build.- See Also:
-
SRC_INCLUDES
The name of the key that lists all the folders and files to be included in the source build.- See Also:
-
JARS_EXTRA_CLASSPATH
The name of the key that declares extra library entries to be added to the class path at build time only..- See Also:
-
SECONDARY_DEPENDENCIES
The name of the key that declares additional plug-in dependencies to augment development classpath- Since:
- 3.2
- See Also:
-
-
Method Details
-
addToken
Adds the token to the list of token for this entry. This method will throw a CoreException if the model is not editable.- Parameters:
token- a name to be added to the list of tokens- Throws:
CoreException- if the model is not editable
-
getModel
IBuildModel getModel()Returns a model that owns this entry- Returns:
- build.properties model
-
getName
String getName()Returns the name of this entry.- Returns:
- the entry name
-
getTokens
String[] getTokens()Returns an array of tokens for this entry- Returns:
- array of tokens
-
contains
Returns true if the provided token exists in this entry.- Parameters:
token- the string token to look for- Returns:
- true if the token exists in the entry
-
removeToken
Removes the token from the list of tokens for this entry. This method will throw a CoreException if the model is not editable.- Parameters:
token- a name to be removed from the list of tokens- Throws:
CoreException- if the model is not editable
-
renameToken
Changes the name of the token without changing its position in the list. This method will throw a CoreException if the model is not editable.- Parameters:
oldToken- the old token namenewToken- the new token name- Throws:
CoreException- if the model is not editable
-
setName
Sets the name of this build entry. This method will throw a CoreException if model is not editable.- Parameters:
name- the new name for the entry- Throws:
CoreException- if the model is not editable
-