|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IWorkbenchProfile
Top-level interface for a Workbench Profile A Workbench profile defines the configuration of a Workbench runtime. It defines a set of elements that will condition how workbench behaves. For example, - which artifacts are available and usable - Are built-in plugins visible (until they disappear as built-in plugins) - Which stereotypes are defined - which primitive type are defined, etc... Profiles are versioned and can be installed on any Workbench install. They are saved in .wbp files which are in fact XML files that have been encrypted. Profiles can be defined by the Workbench Profile Editor/Wizard provided the license includes the proper role (@see IWorkbenchRole for more details) Upon start, Workbench looks for a default.wbp file in the install directory. If not found, a built-in profile is used instead and a warning message is issued. The default.wbp profile can be replaced by any valid Workbench profile. A re-start of Eclipse is required for it to be taken into account.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_PROFILE_FILE
|
static java.lang.String |
FACTORY_PROFILE_FILE
|
static java.lang.String |
FILE_EXTENSION
|
static java.lang.String |
XML_COMPATIBILITY_LEVEL_ATTR
|
static java.lang.String |
XML_DESCRIPTION
|
static java.lang.String |
XML_NAME
|
static java.lang.String |
XML_ROOT_ELEMENT
|
static java.lang.String |
XML_VERSION
|
Method Summary | |
---|---|
void |
addPrimitiveTypeDef(IPrimitiveTypeDef stereotype)
|
void |
addStereotype(IStereotype stereotype)
|
java.lang.String |
asText()
Returns the XML content corresponding to this IWorkbenchProfile It is ready to be encrypted and saved. |
IStereotype[] |
getAvailableStereotypeForCapable(IStereotypeCapable component)
Returns an array of stereotype for a given scope |
IStereotype[] |
getAvailableStereotypeForComponent(IModelComponent component)
Returns an array of stereotype for a given scope |
IPrimitiveTypeDef |
getDefaultPrimitiveType()
|
java.lang.String |
getDefaultPrimitiveTypeString()
|
java.lang.String |
getDescription()
|
java.lang.String |
getName()
|
IPrimitiveTypeDef[] |
getPrimitiveTypeDefs(boolean includeReservedTypes)
|
org.eclipse.tigerstripe.internal.api.profile.IWorkbenchProfileProperty |
getProperty(java.lang.String propertyName)
Returns the value of the property identified by its name |
IStereotype |
getStereotypeByName(java.lang.String name)
Returns the stereotype for the given name. |
IStereotype[] |
getStereotypes()
|
java.lang.String |
getVersion()
|
void |
parse(java.io.Reader reader)
Parses the content into this IWorkbenchProfile. |
void |
removePrimitiveTypeDef(IPrimitiveTypeDef stereotype)
|
void |
removePrimitiveTypeDefs(IPrimitiveTypeDef[] stereotype)
|
void |
removeStereotype(IStereotype stereotype)
|
void |
removeStereotypes(IStereotype[] stereotype)
|
void |
setDefaultPrimitiveType(IPrimitiveTypeDef stereotype)
|
void |
setDescription(java.lang.String description)
|
void |
setName(java.lang.String name)
|
void |
setPrimitiveTypeDefs(IPrimitiveTypeDef[] primitiveTypeDefs)
|
void |
setProperty(java.lang.String propertyName,
org.eclipse.tigerstripe.internal.api.profile.IWorkbenchProfileProperty property)
Sets property propertyName to the given value |
void |
setStereotypes(IStereotype[] stereotypes)
|
void |
setVersion(java.lang.String version)
|
Field Detail |
---|
static final java.lang.String FILE_EXTENSION
static final java.lang.String DEFAULT_PROFILE_FILE
static final java.lang.String FACTORY_PROFILE_FILE
static final java.lang.String XML_COMPATIBILITY_LEVEL_ATTR
static final java.lang.String XML_ROOT_ELEMENT
static final java.lang.String XML_NAME
static final java.lang.String XML_VERSION
static final java.lang.String XML_DESCRIPTION
Method Detail |
---|
void setName(java.lang.String name)
java.lang.String getName()
void setVersion(java.lang.String version)
java.lang.String getVersion()
void setDescription(java.lang.String description)
java.lang.String getDescription()
IStereotype[] getStereotypes()
void setStereotypes(IStereotype[] stereotypes) throws TigerstripeException
TigerstripeException
void addStereotype(IStereotype stereotype) throws TigerstripeException
TigerstripeException
void removeStereotype(IStereotype stereotype) throws TigerstripeException
TigerstripeException
void removeStereotypes(IStereotype[] stereotype) throws TigerstripeException
TigerstripeException
IPrimitiveTypeDef[] getPrimitiveTypeDefs(boolean includeReservedTypes)
void setPrimitiveTypeDefs(IPrimitiveTypeDef[] primitiveTypeDefs) throws TigerstripeException
TigerstripeException
void addPrimitiveTypeDef(IPrimitiveTypeDef stereotype) throws TigerstripeException
TigerstripeException
void removePrimitiveTypeDef(IPrimitiveTypeDef stereotype) throws TigerstripeException
TigerstripeException
void removePrimitiveTypeDefs(IPrimitiveTypeDef[] stereotype) throws TigerstripeException
TigerstripeException
void setDefaultPrimitiveType(IPrimitiveTypeDef stereotype) throws TigerstripeException
TigerstripeException
IPrimitiveTypeDef getDefaultPrimitiveType()
java.lang.String getDefaultPrimitiveTypeString()
java.lang.String asText()
void parse(java.io.Reader reader) throws TigerstripeException
reader
-
TigerstripeException
IStereotype getStereotypeByName(java.lang.String name)
-
IStereotype[] getAvailableStereotypeForComponent(IModelComponent component)
scope
-
IStereotype[] getAvailableStereotypeForCapable(IStereotypeCapable component)
scope
-
org.eclipse.tigerstripe.internal.api.profile.IWorkbenchProfileProperty getProperty(java.lang.String propertyName)
propertyName
-
void setProperty(java.lang.String propertyName, org.eclipse.tigerstripe.internal.api.profile.IWorkbenchProfileProperty property)
propertyName
- property
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |