Vert.x 4.5.13 · io.vertx.core.spi.VerticleFactory · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public default void	close() Close the factory.
public void	createVerticle(String The verticle name verticleName, ClassLoader The class loader classLoader, Promise<Callable<Verticle>> the promise to complete with the result promise) Create a verticle instance.
public default void	init(Vertx The Vert.x instance vertx) Initialise the factory
public default int	Returns: the order order() The order of the factory.
public String	Returns: The prefix for the factory, e.g. "java", or "js". prefix()
public static String	Returns: The identifier without the prefix (if it had any) removePrefix(String the identifier identifer) Helper method to remove a prefix from an identifier string

Method Detail

close	back to summary
public default void close() Close the factory. The implementation must release all resources.

createVerticle back to summary

createVerticle	back to summary
public void createVerticle(String verticleName, ClassLoader classLoader, Promise<Callable<Verticle>> promise) Create a verticle instance. If this method is likely to be slow (e.g. Ruby or JS verticles which might have to start up a language engine) then make sure it is run on a worker thread by `Vertx#executeBlocking`. Parameters verticleName:String The verticle name classLoader:ClassLoader The class loader promise:Promise<Callable<Verticle>> the promise to complete with the result

public void createVerticle(String verticleName, ClassLoader classLoader, Promise<Callable<Verticle>> promise)

Create a verticle instance. If this method is likely to be slow (e.g. Ruby or JS verticles which might have to start up a language engine) then make sure it is run on a worker thread by Vertx#executeBlocking.

Parameters

verticleName:String: The verticle name
classLoader:ClassLoader: The class loader
promise:Promise<Callable<Verticle>>: the promise to complete with the result

init	back to summary
public default void init(Vertx vertx) Initialise the factory Parameters vertx:Vertx The Vert.x instance

init

back to summary

public default void init(Vertx vertx)

Initialise the factory

Parameters

vertx:Vertx: The Vert.x instance

order	back to summary
public default int order() The order of the factory. If there is more than one matching verticle they will be tried in ascending order. Returns:int the order

order

back to summary

public default int order()

The order of the factory. If there is more than one matching verticle they will be tried in ascending order.

Returns:int: the order

prefix	back to summary
public String prefix() Returns:String The prefix for the factory, e.g. "java", or "js".

removePrefix	back to summary
public static String removePrefix(String identifer) Helper method to remove a prefix from an identifier string Parameters identifer:String the identifier Returns:String The identifier without the prefix (if it had any)

removePrefix

back to summary

public static String removePrefix(String identifer)

Helper method to remove a prefix from an identifier string

Parameters

identifer:String: the identifier

Returns:String

The identifier without the prefix (if it had any)

public Interface VerticleFactory

Method Summary

Method Detail