org.apidesign.html.context.spi

Class Contexts

java.lang.Object

org.apidesign.html.context.spi.Contexts

public final class Contexts
extends Object

Factory class to assign various technologies to a browser context. Start with newBuilder() and then assign technologies with Contexts.Builder.register(java.lang.Class, java.lang.Object, int) method.

Author:

Jaroslav Tulach

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Contexts.Builder Support for providers of new BrwsrCtx.
static interface	Contexts.Provider Implementors of various HTML technologies should register their implementation via ServiceProvider so ServiceProvider can find them, when their JARs are included on the classpath of the running application.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	fillInByProviders(Class<?> requestor, Contexts.Builder cb) Seeks ServiceLoader for all registered instances of Contexts.Provider and asks them to fill the builder.
static <Tech> Tech	find(BrwsrCtx context, Class<Tech> technology) Seeks for the specified technology in the provided context.
static Contexts.Builder	newBuilder() Creates new, empty builder for creation of BrwsrCtx.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static Contexts.Builder newBuilder()

Creates new, empty builder for creation of BrwsrCtx. At the end call the Contexts.Builder.build() method to generate the context.

Returns:

new instance of the builder

find

public static <Tech> Tech find(BrwsrCtx context,
               Class<Tech> technology)

Seeks for the specified technology in the provided context.

Type Parameters:

Tech - type of the technology

Parameters:

context - the context to seek in (previously filled with (Contexts.Builder.register(java.lang.Class, java.lang.Object, int))

technology - class that identifies the technology

Returns:

the technology in the context or null

fillInByProviders

public static boolean fillInByProviders(Class<?> requestor,
                        Contexts.Builder cb)

Seeks ServiceLoader for all registered instances of Contexts.Provider and asks them to fill the builder.

Parameters:

requestor - the application class for which to find the context

cb - the context builder to register technologies into

Returns:

true, if some instances of the provider were found, false otherwise

Since:

0.7.6