net.officefloor.eclipse.wizard.teamsource
Class TeamSourceInstance

java.lang.Object
  net.officefloor.eclipse.wizard.teamsource.TeamSourceInstance

All Implemented Interfaces:

CompilerIssues, TeamSourceExtensionContext

public class TeamSourceInstance
extends Object
implements TeamSourceExtensionContext, CompilerIssues

TeamSource instance.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from interface net.officefloor.compile.issues.CompilerIssues

CompilerIssues.LocationType

Method Summary

void	addIssue(CompilerIssues.LocationType locationType, String location, OfficeFloorIssues.AssetType assetType, String assetName, String issueDescription)
void	addIssue(CompilerIssues.LocationType locationType, String location, OfficeFloorIssues.AssetType assetType, String assetName, String issueDescription, Throwable cause)
void	createControls(org.eclipse.swt.widgets.Composite page) Creates the Control instances to populate the TeamLoaderProperty instances.
org.eclipse.core.resources.IProject	getProject() Obtains the IProject that is adding the Team.
PropertyList	getPropertyList() Obtains the PropertyList to source the OfficeTeam from the TeamSource.
String	getTeamName() Obtains the name of the OfficeTeam.
String	getTeamSourceClassName() Obtains the fully qualified class name of the TeamSource.
String	getTeamSourceLabel() Obtains the label for the TeamSource.
TeamType	getTeamType() Obtains the loaded TeamType.
void	loadTeamType() Attempts to load the TeamType.
void	notifyPropertiesChanged() Notifies of a change to the PropertyList.
void	setErrorMessage(String message) Specifies an error message.
void	setTeamName(String teamName) Specifies the location of the OfficeTeam.
void	setTitle(String title) Specifies the title.

Methods inherited from class java.lang.Object

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

Method Detail

setTeamName

public void setTeamName(String teamName)

Specifies the location of the OfficeTeam.

Parameters:

teamName - Name of the OfficeTeam.

loadTeamType

public void loadTeamType()

Attempts to load the TeamType.

getTeamSourceLabel

public String getTeamSourceLabel()

Obtains the label for the TeamSource.

Returns:

Label for the TeamSource.

getTeamSourceClassName

public String getTeamSourceClassName()

Obtains the fully qualified class name of the TeamSource.

Returns:

TeamSource class name.

getTeamName

public String getTeamName()

Obtains the name of the OfficeTeam.

Returns:

Name of the OfficeTeam.

getPropertyList

public PropertyList getPropertyList()

Obtains the PropertyList to source the OfficeTeam from the TeamSource.

Specified by:

getPropertyList in interface TeamSourceExtensionContext

Returns:

Populated PropertyList.

getTeamType

public TeamType getTeamType()

Obtains the loaded TeamType.

Returns:

Loaded TeamType or null if issue loading.

createControls

public void createControls(org.eclipse.swt.widgets.Composite page)

Creates the Control instances to populate the TeamLoaderProperty instances.

Parameters:

page - Composite to add Control instances.

context - TeamSourceInstanceContext.

setTitle

public void setTitle(String title)

Description copied from interface: TeamSourceExtensionContext

Specifies the title.

Specified by:

setTitle in interface TeamSourceExtensionContext

Parameters:

title - Title.

setErrorMessage

public void setErrorMessage(String message)

Description copied from interface: TeamSourceExtensionContext

Specifies an error message. Calling this after notifying of property changes allows for overriding the error message reported to the user.

Specified by:

setErrorMessage in interface TeamSourceExtensionContext

Parameters:

message - Error message. null indicating no error.

notifyPropertiesChanged

public void notifyPropertiesChanged()

Description copied from interface: TeamSourceExtensionContext

Notifies of a change to the PropertyList.

This allows for to report issues in attempting to source the TeamType from the TeamSource with the PropertyList.

Specified by:

notifyPropertiesChanged in interface TeamSourceExtensionContext

getProject

public org.eclipse.core.resources.IProject getProject()

Description copied from interface: TeamSourceExtensionContext

Obtains the IProject that is adding the Team.

Specified by:

getProject in interface TeamSourceExtensionContext

Returns:

IProject that is adding the Team.

addIssue

public void addIssue(CompilerIssues.LocationType locationType,
                     String location,
                     OfficeFloorIssues.AssetType assetType,
                     String assetName,
                     String issueDescription)

Specified by:

addIssue in interface CompilerIssues

addIssue

public void addIssue(CompilerIssues.LocationType locationType,
                     String location,
                     OfficeFloorIssues.AssetType assetType,
                     String assetName,
                     String issueDescription,
                     Throwable cause)

Specified by:

addIssue in interface CompilerIssues