Added
Link Here
|
1 |
/* |
2 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
3 |
* |
4 |
* Copyright 2011 Oracle and/or its affiliates. All rights reserved. |
5 |
* |
6 |
* Oracle and Java are registered trademarks of Oracle and/or its affiliates. |
7 |
* Other names may be trademarks of their respective owners. |
8 |
* |
9 |
* The contents of this file are subject to the terms of either the GNU |
10 |
* General Public License Version 2 only ("GPL") or the Common |
11 |
* Development and Distribution License("CDDL") (collectively, the |
12 |
* "License"). You may not use this file except in compliance with the |
13 |
* License. You can obtain a copy of the License at |
14 |
* http://www.netbeans.org/cddl-gplv2.html |
15 |
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the |
16 |
* specific language governing permissions and limitations under the |
17 |
* License. When distributing the software, include this License Header |
18 |
* Notice in each file and include the License file at |
19 |
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this |
20 |
* particular file as subject to the "Classpath" exception as provided |
21 |
* by Oracle in the GPL Version 2 section of the License file that |
22 |
* accompanied this code. If applicable, add the following below the |
23 |
* License Header, with the fields enclosed by brackets [] replaced by |
24 |
* your own identifying information: |
25 |
* "Portions Copyrighted [year] [name of copyright owner]" |
26 |
* |
27 |
* If you wish your version of this file to be governed by only the CDDL |
28 |
* or only the GPL Version 2, indicate your decision by adding |
29 |
* "[Contributor] elects to include this software in this distribution |
30 |
* under the [CDDL or GPL Version 2] license." If you do not indicate a |
31 |
* single choice of license, a recipient has the option to distribute |
32 |
* your version of this file under either the CDDL, the GPL Version 2 or |
33 |
* to extend the choice of license to its licensees as provided above. |
34 |
* However, if you add GPL Version 2 code and therefore, elected the GPL |
35 |
* Version 2 license, then the option applies only if the new code is |
36 |
* made subject to such option by the copyright holder. |
37 |
* |
38 |
* Contributor(s): |
39 |
* |
40 |
* Portions Copyrighted 2011 Sun Microsystems, Inc. |
41 |
*/ |
42 |
package org.netbeans.api.server; |
43 |
|
44 |
import java.util.ArrayList; |
45 |
import java.util.List; |
46 |
import org.netbeans.api.annotations.common.NonNull; |
47 |
import org.netbeans.modules.server.annotations.VMArgumentsRegistrationProcessor; |
48 |
import org.netbeans.spi.server.VMArgumentsProvider; |
49 |
import org.openide.util.Lookup; |
50 |
import org.openide.util.NbBundle; |
51 |
import org.openide.util.lookup.Lookups; |
52 |
|
53 |
/** |
54 |
* The API class allowing clients, typically server plugins, to query additional |
55 |
* groups of arguments it may pass to VM. |
56 |
* |
57 |
* @author Petr Hejl |
58 |
* @since 1.18 |
59 |
* @see VMArgumentsProvider |
60 |
*/ |
61 |
public final class VMArguments { |
62 |
|
63 |
private final String description; |
64 |
|
65 |
private final List<String> arguments; |
66 |
|
67 |
private VMArguments(String description, List<String> arguments) { |
68 |
this.description = description; |
69 |
this.arguments = arguments; |
70 |
} |
71 |
|
72 |
/** |
73 |
* Returns the groups of arguments provided by all registered |
74 |
* {@link VMArgumentsProvider} for the given start mode. |
75 |
* |
76 |
* @param instanceId the id of a server instance being started |
77 |
* @param mode the VM mode the client is going to use |
78 |
* @return the groups of arguments provided by all registered |
79 |
* {@link VMArgumentsProvider} |
80 |
*/ |
81 |
@NonNull |
82 |
public static List<VMArguments> getVMArguments(String instanceId, StartMode mode) { |
83 |
Lookup lkp = Lookups.forPath(VMArgumentsRegistrationProcessor.PATH); |
84 |
List<VMArguments> res = new ArrayList<VMArguments>(); |
85 |
for (VMArgumentsProvider prov : lkp.lookupAll(VMArgumentsProvider.class)) { |
86 |
res.add(new VMArguments(prov.getDescription(), prov.getArguments(instanceId, mode))); |
87 |
} |
88 |
return res; |
89 |
} |
90 |
|
91 |
/** |
92 |
* Returns the description of group of arguments. |
93 |
* |
94 |
* @return the description of group of arguments |
95 |
*/ |
96 |
@NonNull |
97 |
public String getDescription() { |
98 |
return description; |
99 |
} |
100 |
|
101 |
/** |
102 |
* The list of the VM arguments. |
103 |
* |
104 |
* @return list of the VM arguments |
105 |
*/ |
106 |
@NonNull |
107 |
public List<String> getArguments() { |
108 |
return arguments; |
109 |
} |
110 |
|
111 |
/** |
112 |
* Class representing the startup mode of the VM. |
113 |
*/ |
114 |
public static final class StartMode { |
115 |
|
116 |
/** |
117 |
* The normal startup mode. |
118 |
*/ |
119 |
public static final StartMode NORMAL = new StartMode( |
120 |
NbBundle.getMessage(VMArguments.class, "StartMode_Normal")); |
121 |
|
122 |
/** |
123 |
* The debug startup mode. |
124 |
*/ |
125 |
public static final StartMode DEBUG = new StartMode( |
126 |
NbBundle.getMessage(VMArguments.class, "StartMode_Debug")); |
127 |
|
128 |
/** |
129 |
* The profile startup mode. |
130 |
*/ |
131 |
public static final StartMode PROFILE = new StartMode( |
132 |
NbBundle.getMessage(VMArguments.class, "StartMode_Profile")); |
133 |
|
134 |
private final String mode; |
135 |
|
136 |
private StartMode(String mode) { |
137 |
this.mode = mode; |
138 |
} |
139 |
|
140 |
@Override |
141 |
public String toString() { |
142 |
return mode; |
143 |
} |
144 |
|
145 |
@Override |
146 |
public boolean equals(Object obj) { |
147 |
if (obj == null) { |
148 |
return false; |
149 |
} |
150 |
if (getClass() != obj.getClass()) { |
151 |
return false; |
152 |
} |
153 |
final StartMode other = (StartMode) obj; |
154 |
if ((this.mode == null) ? (other.mode != null) : !this.mode.equals(other.mode)) { |
155 |
return false; |
156 |
} |
157 |
return true; |
158 |
} |
159 |
|
160 |
@Override |
161 |
public int hashCode() { |
162 |
int hash = 3; |
163 |
hash = 29 * hash + (this.mode != null ? this.mode.hashCode() : 0); |
164 |
return hash; |
165 |
} |
166 |
} |
167 |
} |