2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 * Copyright 1997-2010 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-2013 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.apidesign.html.context.spi;
45 import net.java.html.BrwsrCtx;
46 import org.netbeans.html.context.impl.CtxImpl;
50 * @author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
52 public final class Contexts {
56 /** Creates new, empty builder for creation of {@link BrwsrCtx}. At the
57 * end call the {@link #build()} method to generate the context.
59 * @return new instance of the builder
61 public static Builder newBuilder() {
65 /** Seeks for the specified technology in the provided context.
67 * @param <Tech> type of the technology
68 * @param context the context to seek in
69 * (previously filled with ({@link Builder#register(java.lang.Class, java.lang.Object, int)})
70 * @param technology class that identifies the technology
73 public static <Tech> Tech find(BrwsrCtx context, Class<Tech> technology) {
74 return CtxImpl.find(context, technology);
77 /** Implementors of various HTML technologies should
78 * register their implementation via {@link ServiceProvider} so
79 * {@link ServiceProvider} can find them, when their JARs are included
80 * on the classpath of the running application.
82 * @author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
84 public static interface Provider {
86 /** Register into the context if suitable technology is
87 * available for the requesting class.
88 * The provider should check if its own technology is available in current
89 * scope (e.g. proper JDK, proper browser, etc.). The provider
90 * can also find the right context depending on requestor's classloader, etc.
92 * Providers should use {@link Builder} to enrich appropriately
95 * @param context the context builder to fill with technologies
96 * @param requestor the application class requesting access the the HTML page
97 * @see BrwsrCtx#findDefault(java.lang.Class)
99 void fillContext(Builder context, Class<?> requestor);
102 /** Support for providers of new {@link BrwsrCtx}. Providers of different
103 * technologies should be of particular interest in this class. End users
104 * designing their application with existing technologies should rather
105 * point their attention to {@link BrwsrCtx} and co.
107 * @author Jaroslav Tulach <jtulach@netbeans.org>
109 public static final class Builder {
110 private final CtxImpl impl = new CtxImpl();
115 /** Registers new technology into the context. Each technology is
116 * exactly identified by its implementation class and can be associated
117 * with (positive) priority. In case of presence of multiple technologies
118 * with the same class, the one with higher lower priority takes precedence.
119 * @param <Tech> type of technology to register
120 * @param type the real class of the technology type
121 * @param impl an instance of the technology class
122 * @param position the lower position, the more important implementation
123 * which will be consulted sooner when seeking for a {@link Contexts#find(net.java.html.BrwsrCtx, java.lang.Class)}
125 * @return this builder
127 public <Tech> Builder register(Class<Tech> type, Tech impl, int position) {
129 throw new IllegalStateException();
131 this.impl.register(type, impl, position);
135 /** Generates context based on values previously inserted into
138 * @return new, immutable instance of {@link BrwsrCtx}
140 public BrwsrCtx build() {