org.netbeans.modules.maven.api.customizer

Class ModelHandle

java.lang.Object

org.netbeans.modules.maven.api.customizer.ModelHandle

public final class ModelHandle
extends Object

ModelHandle instance is passed down to customizer panel providers in the context lookup.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelHandle.Configuration a javabean wrapper for configurations within the project customizer

Field Summary

Fields

Modifier and Type	Field and Description
static String	PANEL_BASIC
static String	PANEL_COMPILE
static String	PANEL_CONFIGURATION
static String	PANEL_LIBRARIES
static String	PANEL_MAPPING
static String	PANEL_RUN
static String	PANEL_SOURCES

Method Summary

Modifier and Type	Method and Description
void	addConfiguration(ModelHandle.Configuration config)
static ModelHandle.Configuration	createCustomConfiguration(String id)
static ModelHandle.Configuration	createDefaultConfiguration()
static ModelHandle.Configuration	createProfileConfiguration(String id)
ActionToGoalMapping	getActionMappings() action mapping model
ActionToGoalMapping	getActionMappings(ModelHandle.Configuration config) action mapping model
ModelHandle.Configuration	getActiveConfiguration()
List<ModelHandle.Configuration>	getConfigurations()
static NetbeansActionMapping	getDefaultMapping(String action, Project project)
static NetbeansActionMapping	getMapping(String action, Project project, ProjectConfiguration config) Load a particular action mapping.
org.netbeans.modules.maven.model.pom.POMModel	getPOMModel() pom.xml model
org.apache.maven.project.MavenProject	getProject() the non changed (not-to-be-changed) instance of the complete project.
String	getRawAuxiliaryProperty(String propertyName, boolean shared) get the value of Auxiliary property defined in the project, however take only the content in nb-configurations.xml file into account, never consider values from pom.xml here.
boolean	isModified(Object obj)
void	markAsModified(Object obj) always after modifying the models, mark them as modified.
static void	putMapping(NetbeansActionMapping mapp, Project project, ProjectConfiguration config) Store a particular action mapping.
void	removeConfiguration(ModelHandle.Configuration config)
void	setActiveConfiguration(ModelHandle.Configuration conf)
void	setRawAuxiliaryProperty(String propertyName, String value, boolean shared) set the value of Auxiliary property, will be written to nb-configurations.xml file
static void	setUserActionMapping(NetbeansActionMapping action, ActionToGoalMapping mapp) inserts the action definition in the right place based on matching action name.

Methods inherited from class java.lang.Object

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

Field Detail

PANEL_RUN

public static final String PANEL_RUN

See Also:

Constant Field Values

PANEL_BASIC

public static final String PANEL_BASIC

See Also:

Constant Field Values

PANEL_CONFIGURATION

public static final String PANEL_CONFIGURATION

See Also:

Constant Field Values

PANEL_MAPPING

public static final String PANEL_MAPPING

See Also:

Constant Field Values

PANEL_LIBRARIES

public static final String PANEL_LIBRARIES

See Also:

Constant Field Values

PANEL_SOURCES

public static final String PANEL_SOURCES

See Also:

Constant Field Values

PANEL_COMPILE

public static final String PANEL_COMPILE

See Also:

Constant Field Values

Method Detail

getPOMModel

public org.netbeans.modules.maven.model.pom.POMModel getPOMModel()

pom.xml model

Returns:

getProject

public org.apache.maven.project.MavenProject getProject()

the non changed (not-to-be-changed) instance of the complete project. NOT TO BE CHANGED.

Returns:

getRawAuxiliaryProperty

public String getRawAuxiliaryProperty(String propertyName,
                                      boolean shared)

get the value of Auxiliary property defined in the project, however take only the content in nb-configurations.xml file into account, never consider values from pom.xml here.

Parameters:

propertyName -

shared -

Returns:

setRawAuxiliaryProperty

public void setRawAuxiliaryProperty(String propertyName,
                                    String value,
                                    boolean shared)

set the value of Auxiliary property, will be written to nb-configurations.xml file

Parameters:

propertyName -

shared -

value -

getActionMappings

public ActionToGoalMapping getActionMappings()

action mapping model

Returns:

getActionMappings

public ActionToGoalMapping getActionMappings(ModelHandle.Configuration config)

action mapping model

Parameters:

config -

Returns:

setUserActionMapping

public static void setUserActionMapping(NetbeansActionMapping action,
                                        ActionToGoalMapping mapp)

inserts the action definition in the right place based on matching action name. replaces old defintion or appends at the end.

Parameters:

action -

mapp -

getDefaultMapping

@CheckForNull
public static NetbeansActionMapping getDefaultMapping(String action,
                                                                    Project project)

Since:

2.19

getMapping

@CheckForNull
public static NetbeansActionMapping getMapping(String action,
                                                             Project project,
                                                             ProjectConfiguration config)

Load a particular action mapping.

Parameters:

action - an action name

project - a Maven project

config - a configuration of that project

Returns:

an action mapping model, or null

Since:

2.19

putMapping

public static void putMapping(NetbeansActionMapping mapp,
                              Project project,
                              ProjectConfiguration config)
                       throws IOException

Store a particular action mapping.

Parameters:

mapp - an action mapping model

project - a Maven project

config - a configuration of that project

Throws:

IOException - in case of trouble

Since:

2.19

getConfigurations

public List<ModelHandle.Configuration> getConfigurations()

addConfiguration

public void addConfiguration(ModelHandle.Configuration config)

removeConfiguration

public void removeConfiguration(ModelHandle.Configuration config)

getActiveConfiguration

public ModelHandle.Configuration getActiveConfiguration()

setActiveConfiguration

public void setActiveConfiguration(ModelHandle.Configuration conf)

isModified

public boolean isModified(Object obj)

markAsModified

public void markAsModified(Object obj)

always after modifying the models, mark them as modified. without the marking, the particular file will not be saved.

Parameters:

obj - either getPOMModel() or getActionMappings()

createProfileConfiguration

public static ModelHandle.Configuration createProfileConfiguration(String id)

createDefaultConfiguration

public static ModelHandle.Configuration createDefaultConfiguration()

createCustomConfiguration

public static ModelHandle.Configuration createCustomConfiguration(String id)