com.ibm.etools.iseries.remotebuild
Class BuildStyle

java.lang.Object
  com.ibm.etools.iseries.remotebuild.BuildStyle

All Implemented Interfaces:

IBuildStyle

Direct Known Subclasses:

CommandBuildStyle, ProgramBuildStyle

public abstract class BuildStyle
extends Object
implements IBuildStyle

Provides a basic implementation of IBuildStyle.

All contributed build styles must subclass this since there is initialization support provided by this class.

Field Summary

static String

Copyright

Constructor Summary

BuildStyle()
Constructor for a BuildStyle.

Method Summary

IBuildStyleConfiguration	getDefaultConfiguration() Returns a default configuration of this build style.
static String	getDefaultStyleId() Returns the default build style id for the workspace.
abstract String	getDescription() Returns a short description of the build style suitable for displaying in a user interface.
abstract IBuildStyleConfiguration	getEmptyConfiguration() Returns an empty configuration.
String	getId() Returns the id for this build style.
static String	getNullStyleId() Returns the id of the NullBuildStyle.
String	getVendorString() Returns the vendor description of the build style.
abstract boolean	isConfigurable() Returns true if the build style is configurable by the user.
void	setDeclaringPluginBundle(Bundle bundle) Remembers the plugin descriptor that defined this build style.
static void	setDefaultStyleId(String styleId) Sets the default build style id for the workspace.
void	setId(String id) Sets the id for this build style.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Copyright

public static final String Copyright

See Also:

Constant Field Values

Constructor Detail

BuildStyle

public BuildStyle()

Constructor for a BuildStyle.

Method Detail

getDefaultStyleId

public static String getDefaultStyleId()

Returns the default build style id for the workspace. Returns the id of the highest priority build style if the default style is not found.

getNullStyleId

public static String getNullStyleId()

Returns the id of the NullBuildStyle.

setDefaultStyleId

public static void setDefaultStyleId(String styleId)

Sets the default build style id for the workspace.

This should be set only by the dialog that establishes the default for the workspace. This dialog is provided by the internal portion of this plugin.

setDeclaringPluginBundle

public final void setDeclaringPluginBundle(Bundle bundle)

Remembers the plugin descriptor that defined this build style.

Called as part of the initialization of this build style.

Specified by:

setDeclaringPluginBundle in interface IBuildStyle

getVendorString

public final String getVendorString()

Returns the vendor description of the build style. This is the implementation for all build styles.

Specified by:

getVendorString in interface IBuildStyle

setId

public final void setId(String id)

Sets the id for this build style.

Called as part of the initialization of this build style.

Specified by:

setId in interface IBuildStyle

getId

public final String getId()

Returns the id for this build style.

Specified by:

getId in interface IBuildStyle

getDefaultConfiguration

public final IBuildStyleConfiguration getDefaultConfiguration()

Returns a default configuration of this build style.

Specified by:

getDefaultConfiguration in interface IBuildStyle

getEmptyConfiguration

public abstract IBuildStyleConfiguration getEmptyConfiguration()

Returns an empty configuration. Used by getDefaultConfiguration() to supply the base configuration into which defaults are loaded.

Must be implemented by subclasses.

See Also:

getDefaultConfiguration()

isConfigurable

public abstract boolean isConfigurable()

Returns true if the build style is configurable by the user.

Must be implemented by subclasses.

Specified by:

isConfigurable in interface IBuildStyle

See Also:

IBuildStyleConfiguration

getDescription

public abstract String getDescription()

Returns a short description of the build style suitable for displaying in a user interface.

Must be implemented by subclasses.

Specified by:

getDescription in interface IBuildStyle