| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| package org.netbeans.modules.maven.api; |
| |
| import java.util.Arrays; |
| import java.util.List; |
| |
| /** |
| * Various constants used across the integration, Maven property names with a meaning in the IDE, |
| * plugin groupIds, artifactIds etc. |
| * @author mkleint |
| */ |
| public interface Constants { |
| |
| /** |
| * MIME type for {@code *.pom}. |
| */ |
| String POM_MIME_TYPE = "text/x-maven-pom+xml"; |
| /** |
| * Maven property that hints netbeans to use a given license template. |
| */ |
| public static final String HINT_LICENSE = "netbeans.hint.license"; //NOI18N |
| |
| /** |
| * Maven property that hints netbeans to use a given license template file in project space, rather than the IDE's user space |
| */ |
| public static final String HINT_LICENSE_PATH = "netbeans.hint.licensePath"; //NOI18N |
| |
| /** |
| * Maven property that designates the jdk platform to use in the IDE on classpath for project. |
| * Equivalent to the "platform.active" property in Ant based projects. |
| * Workaround for issue http://www.netbeans.org/issues/show_bug.cgi?id=104974 |
| * Will only influence the classpath in the IDE, not the maven build itself. |
| */ |
| public static final String HINT_JDK_PLATFORM = "netbeans.hint.jdkPlatform"; //NOI18N |
| |
| /** |
| * maven property disabling whitelist processing in netbeans module projects. |
| */ |
| // public static final String HINT_WHITELIST = "netbeans.hint.disable.whitelist"; |
| |
| /** |
| * Maven property that hints netbeans to handle the project as if it were of given packaging.. |
| * Influences the available default action mappings, panels in customizers and other UI functionality in the IDE. |
| * Useful for cases when you define a custom packaging eg "jar2" but want the ide to handle it as j2se/jar project. |
| * Meaningful values include: jar,war,ejb,ear,nbm |
| */ |
| public static final String HINT_PACKAGING = "netbeans.hint.packaging"; //NOI18N |
| |
| /** |
| * allows to customize project's display name. The global equivalent is $userhome/Preferences/org/netbeans/modules/maven.properties' property of project.displayName |
| */ |
| public static final String HINT_DISPLAY_NAME = "netbeans.hint.displayName"; |
| |
| /** |
| * apache maven default groupid for maven plugins. |
| */ |
| public static final String GROUP_APACHE_PLUGINS = "org.apache.maven.plugins"; //NOI18N |
| |
| public static final String PLUGIN_COMPILER = "maven-compiler-plugin";//NOI18N |
| public static final String PLUGIN_COMPILER_VERSION_SUPPORTING_JDK9 = "3.6"; // NOI18N |
| |
| public static final String PLUGIN_WAR = "maven-war-plugin";//NOI18N |
| public static final String PLUGIN_SITE = "maven-site-plugin";//NOI18N |
| public static final String PLUGIN_RESOURCES = "maven-resources-plugin";//NOI18N |
| public static final String PLUGIN_EJB = "maven-ejb-plugin";//NOI18N |
| public static final String PLUGIN_EAR = "maven-ear-plugin";//NOI18N |
| public static final String PLUGIN_JAR = "maven-jar-plugin";//NOI18N |
| public static final String PLUGIN_SUREFIRE = "maven-surefire-plugin";//NOI18N |
| public static final String PLUGIN_FAILSAFE = "maven-failsafe-plugin";//NOI18N |
| public static final String PLUGIN_CHECKSTYLE = "maven-checkstyle-plugin";//NOI18N |
| |
| public static final String ENCODING_PARAM = "encoding"; //NOI18N |
| public static final String RELEASE_PARAM = "release";//NOI18N |
| public static final String SOURCE_PARAM = "source";//NOI18N |
| public static final String TARGET_PARAM = "target";//NOI18N |
| |
| /** |
| * |
| * this property was introduced as part of this proposal: |
| * http://docs.codehaus.org/display/MAVENUSER/POM+Element+for+Source+File+Encoding |
| */ |
| public static String ENCODING_PROP = "project.build.sourceEncoding"; //NOI18N |
| |
| |
| /** |
| * When used as a property when executing maven, it will start a debugger before invoking a project related action. |
| * will replace the ${jpda.address} expression in action's properties with the correct value of |
| * localhost port number. |
| * allowed values: |
| * <ul> |
| * <li> |
| * true - starts the debugger and waits for the process to attach to it. |
| * </li> |
| * <li> |
| * maven - starts the debugger and generates correct MAVEN_OPTS value that is passed to the command line maven executable. |
| * MAVEN_OPTS=-agentlib:jdwp=transport=dt_socket,server=n,address=${jpda.address} |
| * </li> |
| * </ul> |
| */ |
| public static final String ACTION_PROPERTY_JPDALISTEN = "jpda.listen"; |
| |
| /** |
| * When used as a property when executing maven, it will attach a debugger |
| * to the provided address. |
| * The transport used when attaching to that address is a socket attach be default, |
| * which expects the address to be in the form of <host_name>:<port_number>. |
| * A different transport can be defined by {@link #ACTION_PROPERTY_JPDAATTACH_TRANSPORT}. |
| * Possible value is also <code>true</code> in which case a free port |
| * is allocated and value of this property and properties |
| * {@link #ACTION_PROPERTY_JPDAATTACH_ADDRESS} and |
| * {@link #ACTION_PROPERTY_JPDAATTACH_PORT} updated accordingly. |
| * @since 2.113 |
| */ |
| public static final String ACTION_PROPERTY_JPDAATTACH = "jpda.attach"; |
| |
| /** If the {@link #ACTION_PROPERTY_JPDAATTACH} property is specified |
| * as <code>true</code> this property is then set to the address |
| * (usually <code>localhost</code>) to connect to. |
| * @since 2.113 |
| */ |
| public static final String ACTION_PROPERTY_JPDAATTACH_ADDRESS = "jpda.attach.address"; |
| /** If the {@link #ACTION_PROPERTY_JPDAATTACH} property is specified |
| * as <code>true</code> this property is then set to an empty port the |
| * system will then connect to. |
| * |
| * @since 2.113 |
| */ |
| public static final String ACTION_PROPERTY_JPDAATTACH_PORT = "jpda.attach.port"; |
| |
| /** |
| * When used as a property when executing maven, it will use this transport |
| * when attaching to {@link #ACTION_PROPERTY_JPDAATTACH_ADDRESS} address. |
| * This property is meaningful only when {@link #ACTION_PROPERTY_JPDAATTACH_ADDRESS} |
| * is defined. |
| * @since 2.113 |
| */ |
| public static final String ACTION_PROPERTY_JPDAATTACH_TRANSPORT = "jpda.attach.transport"; |
| |
| /** |
| * Name of a property used for checking the maven output for the approriate time to attach to |
| * {@link #ACTION_PROPERTY_JPDAATTACH_ADDRESS} address. |
| * This property is meaningful only when {@link #ACTION_PROPERTY_JPDAATTACH_ADDRESS} |
| * is defined. |
| * @since 2.127 |
| */ |
| public static final String ACTION_PROPERTY_JPDAATTACH_TRIGGER = "jpda.attach.trigger"; |
| |
| /** |
| * Optional property, if defined the project type will attempt to redirect meaningful |
| * run/debug/profile/test action invokations to the compile on save infrastructure. |
| * Possible values |
| * <ul> |
| * <li>all - both tests and application</li> |
| * <li>test - only tests, not application - deprecated since 7.4</li> |
| * <li>app - only application, not tests - deprecated since 7.4</li> |
| * <li>none - no compile on save |
| * </ul> |
| * @since NetBeans 6.7 |
| */ |
| public static final String HINT_COMPILE_ON_SAVE = "netbeans.compile.on.save"; //NOI18N |
| |
| /** |
| * Optional property, if defined the IDE will try to use the project's checkstyle configuration |
| * to transparently change the java files formatting (according to the setup rules) |
| * @since NetBeans 6.8 |
| */ |
| public static final String HINT_CHECKSTYLE_FORMATTING = "netbeans.checkstyle.format"; //NOI18N |
| |
| |
| /** |
| * list of phase names in default lifecycle |
| */ |
| public static final List<String> DEFAULT_PHASES = Arrays.asList(new String[] { |
| "validate", |
| "initialize", |
| "generate-sources", |
| "process-sources", |
| "generate-resources", |
| "process-resources", |
| "compile", |
| "process-classes", |
| "generate-test-sources", |
| "process-test-sources", |
| "generate-test-resources", |
| "process-test-resources", |
| "test-compile", |
| "process-test-classes", |
| "test", |
| "prepare-package", |
| "package", |
| "pre-integration-test", |
| "integration-test", |
| "post-integration-test", |
| "verify", |
| "install", |
| "deploy" |
| }); |
| |
| /** |
| * list of phase names in clean lifecycle |
| */ |
| public static final List<String> CLEAN_PHASES = Arrays.asList(new String[] { |
| "pre-clean", |
| "clean", |
| "post-clean" |
| }); |
| } |
