Faceted Project Framework
Version 1.3

org.eclipse.wst.common.project.facet.core
Interface IFacetedProjectWorkingCopy

All Superinterfaces:
IFacetedProjectBase

public interface IFacetedProjectWorkingCopy
extends IFacetedProjectBase

Author:
Konstantin Komissarchik

Field Summary
 
Fields inherited from interface org.eclipse.wst.common.project.facet.core.IFacetedProjectBase
PROBLEM_OTHER, PROBLEM_PROJECT_NAME
 
Method Summary
 void addProjectFacet(IProjectFacetVersion fv)
           
 void addTargetedRuntime(IRuntime runtime)
           
 void changeProjectFacetVersion(IProjectFacetVersion fv)
           
 IFacetedProjectWorkingCopy clone()
           
 void commitChanges(IProgressMonitor monitor)
           
 void dispose()
           
 Map<IProjectFacet,SortedSet<IProjectFacetVersion>> getAvailableFacets()
           
 Set<IPreset> getAvailablePresets()
           
 SortedSet<IProjectFacetVersion> getAvailableVersions(IProjectFacet f)
           
 IPreset getDefaultConfiguration()
          Returns the default configuration preset.
 IFacetedProject getFacetedProject()
           
 IProjectFacetVersion getHighestAvailableVersion(IProjectFacet f)
           
 IPreset getMinimalConfiguration()
          Returns the minimal configuration preset.
 IFacetedProject.Action getProjectFacetAction(IProjectFacet facet)
           
 Set<IFacetedProject.Action> getProjectFacetActions()
           
 IPath getProjectLocation()
           
 String getProjectName()
           
 IPreset getSelectedPreset()
           
 Set<IRuntime> getTargetableRuntimes()
           
 boolean isDirty()
           
 boolean isFacetAvailable(IProjectFacet f)
           
 boolean isFacetAvailable(IProjectFacetVersion fv)
           
 void mergeChanges(IFacetedProjectWorkingCopy fpjwc)
           
 void refreshTargetableRuntimes()
           
 void removeProjectFacet(IProjectFacet f)
           
 void removeProjectFacet(IProjectFacetVersion fv)
           
 void removeTargetedRuntime(IRuntime runtime)
           
 void revertChanges()
           
 void setFixedProjectFacets(Set<IProjectFacet> fixed)
           
 void setPrimaryRuntime(IRuntime runtime)
           
 void setProjectFacetActionConfig(IProjectFacet facet, Object newActionConfig)
           
 void setProjectFacets(Set<IProjectFacetVersion> facets)
           
 void setProjectLocation(IPath location)
           
 void setProjectName(String name)
           
 void setSelectedPreset(String presetId)
           
 void setTargetedRuntimes(Set<IRuntime> runtimes)
           
 
Methods inherited from interface org.eclipse.wst.common.project.facet.core.IFacetedProjectBase
addListener, getFixedProjectFacets, getPrimaryRuntime, getProject, getProjectFacets, getProjectFacetVersion, getTargetedRuntimes, hasProjectFacet, hasProjectFacet, isFixedProjectFacet, isTargetable, isTargeted, removeListener, validate, validate
 

Method Detail

getProjectName

String getProjectName()

setProjectName

void setProjectName(String name)

getProjectLocation

IPath getProjectLocation()

setProjectLocation

void setProjectLocation(IPath location)

getFacetedProject

IFacetedProject getFacetedProject()

getAvailableFacets

Map<IProjectFacet,SortedSet<IProjectFacetVersion>> getAvailableFacets()

isFacetAvailable

boolean isFacetAvailable(IProjectFacet f)

isFacetAvailable

boolean isFacetAvailable(IProjectFacetVersion fv)

getAvailableVersions

SortedSet<IProjectFacetVersion> getAvailableVersions(IProjectFacet f)

getHighestAvailableVersion

IProjectFacetVersion getHighestAvailableVersion(IProjectFacet f)

setFixedProjectFacets

void setFixedProjectFacets(Set<IProjectFacet> fixed)

setProjectFacets

void setProjectFacets(Set<IProjectFacetVersion> facets)

addProjectFacet

void addProjectFacet(IProjectFacetVersion fv)

removeProjectFacet

void removeProjectFacet(IProjectFacet f)

removeProjectFacet

void removeProjectFacet(IProjectFacetVersion fv)

changeProjectFacetVersion

void changeProjectFacetVersion(IProjectFacetVersion fv)

getAvailablePresets

Set<IPreset> getAvailablePresets()

getSelectedPreset

IPreset getSelectedPreset()

setSelectedPreset

void setSelectedPreset(String presetId)

getDefaultConfiguration

IPreset getDefaultConfiguration()
Returns the default configuration preset.

Note that calling this method from a dynamic preset factory implementation can result in out-of-date information being returned as this preset many not have been refreshed yet. Extenders wishing to reference default configuration when implementing a new dynamic preset should extend DefaultConfigurationPresetFactory class instead.

Returns:
the default configuration preset

getMinimalConfiguration

IPreset getMinimalConfiguration()
Returns the minimal configuration preset.

Note that calling this method from a dynamic preset factory implementation can result in out-of-date information being returned as this preset many not have been refreshed yet. Extenders wishing to reference default configuration when implementing a new dynamic preset should extend MinimalConfigurationPresetFactory class instead.

Returns:
the minimal configuration preset

getTargetableRuntimes

Set<IRuntime> getTargetableRuntimes()

refreshTargetableRuntimes

void refreshTargetableRuntimes()

setTargetedRuntimes

void setTargetedRuntimes(Set<IRuntime> runtimes)

addTargetedRuntime

void addTargetedRuntime(IRuntime runtime)

removeTargetedRuntime

void removeTargetedRuntime(IRuntime runtime)

setPrimaryRuntime

void setPrimaryRuntime(IRuntime runtime)

getProjectFacetActions

Set<IFacetedProject.Action> getProjectFacetActions()

getProjectFacetAction

IFacetedProject.Action getProjectFacetAction(IProjectFacet facet)

setProjectFacetActionConfig

void setProjectFacetActionConfig(IProjectFacet facet,
                                 Object newActionConfig)

isDirty

boolean isDirty()
Since:
1.4

commitChanges

void commitChanges(IProgressMonitor monitor)
                   throws CoreException
Throws:
CoreException

mergeChanges

void mergeChanges(IFacetedProjectWorkingCopy fpjwc)

revertChanges

void revertChanges()

clone

IFacetedProjectWorkingCopy clone()

dispose

void dispose()

Faceted Project Framework
Version 1.3

Copyright (c) 2008 Oracle and others. All rights reserved.