2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
6 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7 * Other names may be trademarks of their respective owners.
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]"
29 * The Original Software is NetBeans. The Initial Developer of the Original
30 * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
32 * If you wish your version of this file to be governed by only the CDDL
33 * or only the GPL Version 2, indicate your decision by adding
34 * "[Contributor] elects to include this software in this distribution
35 * under the [CDDL or GPL Version 2] license." If you do not indicate a
36 * single choice of license, a recipient has the option to distribute
37 * your version of this file under either the CDDL, the GPL Version 2 or
38 * to extend the choice of license to its licensees as provided above.
39 * However, if you add GPL Version 2 code and therefore, elected the GPL
40 * Version 2 license, then the option applies only if the new code is
41 * made subject to such option by the copyright holder.
43 package org.netbeans.html.context.spi;
45 import java.lang.annotation.Documented;
46 import java.lang.annotation.ElementType;
47 import java.lang.annotation.Retention;
48 import java.lang.annotation.RetentionPolicy;
49 import java.lang.annotation.Target;
50 import java.util.HashSet;
51 import java.util.ServiceLoader;
53 import net.java.html.BrwsrCtx;
54 import org.netbeans.html.context.impl.CtxImpl;
56 /** Factory class to assign various technologies
57 * to a {@link BrwsrCtx browser context}. Start with {@link #newBuilder()}
58 * and then assign technologies with {@link Builder#register(java.lang.Class, java.lang.Object, int)}
61 * @author Jaroslav Tulach
63 public final class Contexts {
67 /** Creates new, empty builder for creation of {@link BrwsrCtx}. At the
68 * end call the {@link Builder#build()} method to generate the context.
70 * @param context instances of various classes or names of {@link Id technologies}
71 * to be preferred and used in the built {@link BrwsrCtx context}.
72 * @return new instance of the builder
75 public static Builder newBuilder(Object... context) {
76 return new Builder(context);
78 /** Creates new, empty builder for creation of {@link BrwsrCtx}. At the
79 * end call the {@link Builder#build()} method to generate the context.
80 * Simply calls {@link #newBuilder(java.lang.Object...) newBuilder(new Object[0])}.
82 * @return new instance of the builder
84 public static Builder newBuilder() {
85 return newBuilder(new Object[0]);
88 /** Seeks for the specified technology in the provided context.
90 * @param <Tech> type of the technology
91 * @param context the context to seek in
92 * (previously filled with ({@link Builder#register(java.lang.Class, java.lang.Object, int)})
93 * @param technology class that identifies the technology
94 * @return the technology in the context or <code>null</code>
96 public static <Tech> Tech find(BrwsrCtx context, Class<Tech> technology) {
97 return CtxImpl.find(context, technology);
100 /** Seeks {@link ServiceLoader} for all registered instances of
101 * {@link Provider} and asks them to {@link Provider#fillContext(org.netbeans.html.context.spi.Contexts.Builder, java.lang.Class) fill
104 * @param requestor the application class for which to find the context
105 * @param cb the context builder to register technologies into
106 * @return <code>true</code>, if some instances of the provider were
107 * found, <code>false</code> otherwise
110 public static boolean fillInByProviders(Class<?> requestor, Contexts.Builder cb) {
111 boolean found = false;
114 l = requestor.getClassLoader();
115 } catch (SecurityException ex) {
118 Set<Class<?>> classes = new HashSet<Class<?>>();
119 for (Provider cp : ServiceLoader.load(Provider.class, l)) {
120 if (!classes.add(cp.getClass())) {
123 cp.fillContext(cb, requestor);
127 for (Provider cp : ServiceLoader.load(Provider.class, Provider.class.getClassLoader())) {
128 if (!classes.add(cp.getClass())) {
131 cp.fillContext(cb, requestor);
134 } catch (SecurityException ex) {
140 for (Provider cp : ServiceLoader.load(Provider.class)) {
141 if (!classes.add(cp.getClass())) {
144 cp.fillContext(cb, requestor);
151 /** Identifies the technologies passed to {@link Builder context builder}
152 * by a name. Each implementation of a technology
153 * {@link Builder#register(java.lang.Class, java.lang.Object, int) registered into a context}
154 * can be annotated with a name (or multiple names). Such implementation
156 * {@link Contexts#fillInByProviders(java.lang.Class, org.netbeans.html.context.spi.Contexts.Builder) preferred during lookup}
157 * if their name(s) has been requested in when
158 * {@link Contexts#newBuilder(java.lang.Object...) creating a context}.
161 @Retention(RetentionPolicy.RUNTIME)
162 @Target(ElementType.TYPE)
164 public @interface Id {
165 /** Identifier(s) for the implementation.
167 * @return one of more identifiers giving this implementation name(s)
169 public String[] value();
172 /** Implementors of various HTML technologies should
173 * register their implementation via <code>org.openide.util.lookup.ServiceProvider</code>, so
174 * {@link ServiceLoader} can find them, when their JARs are included
175 * on the classpath of the running application.
177 * @author Jaroslav Tulach
179 public static interface Provider {
181 /** Register into the context if suitable technology is
182 * available for the requesting class.
183 * The provider should check if its own technology is available in current
184 * scope (e.g. proper JDK, proper browser, etc.). The provider
185 * can also find the right context depending on requestor's classloader, etc.
187 * Providers should use {@link Builder} to enrich appropriately
190 * @param context the context builder to fill with technologies
191 * @param requestor the application class requesting access the the HTML page
192 * @see BrwsrCtx#findDefault(java.lang.Class)
194 void fillContext(Builder context, Class<?> requestor);
197 /** Support for providers of new {@link BrwsrCtx}. Providers of different
198 * technologies should be of particular interest in this class. End users
199 * designing their application with existing technologies should rather
200 * point their attention to {@link BrwsrCtx} and co.
202 * @author Jaroslav Tulach
204 public static final class Builder {
205 private final CtxImpl impl;
207 public Builder(Object[] context) {
208 this.impl = new CtxImpl(context);
211 /** Registers new technology into the context. Each technology is
212 * exactly identified by its implementation class and can be associated
213 * with (positive) priority. In case of presence of multiple technologies
214 * with the same class, the one with higher lower priority takes precedence.
215 * @param <Tech> type of technology to register
216 * @param type the real class of the technology type
217 * @param impl an instance of the technology class
218 * @param position the lower position, the more important implementation
219 * which will be consulted sooner when seeking for a {@link Contexts#find(net.java.html.BrwsrCtx, java.lang.Class)}
221 * @return this builder
223 public <Tech> Builder register(Class<Tech> type, Tech impl, int position) {
228 throw new IllegalStateException();
230 this.impl.register(type, impl, position);
234 /** Generates context based on values previously inserted into
237 * @return new, immutable instance of {@link BrwsrCtx}
239 public BrwsrCtx build() {