net.kencochrane.raven

Class RavenFactory

java.lang.Object

net.kencochrane.raven.RavenFactory

Direct Known Subclasses:

DefaultRavenFactory

public abstract class RavenFactory
extends Object

Factory in charge of creating Raven instances.

The factories register themselves through the ServiceLoader system.

Constructor Summary

Constructors

Constructor and Description
RavenFactory()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Raven	createRavenInstance(Dsn dsn) Creates an instance of Raven given a DSN.
static Raven	ravenInstance() Creates an instance of Raven using the DSN obtain through Dsn.dsnLookup().
static Raven	ravenInstance(Dsn dsn) Creates an instance of Raven using the provided DSN.
static Raven	ravenInstance(Dsn dsn, String ravenFactoryName) Creates an instance of Raven using the provided DSN and the specified factory.
static Raven	ravenInstance(String dsn) Creates an instance of Raven using the provided DSN.
static void	registerFactory(RavenFactory ravenFactory) Manually adds a RavenFactory to the system.

Methods inherited from class java.lang.Object

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

Constructor Detail

RavenFactory

public RavenFactory()

Method Detail

registerFactory

public static void registerFactory(RavenFactory ravenFactory)

Manually adds a RavenFactory to the system.

Usually RavenFactories are automatically detected with the ServiceLoader system, but some systems such as Android do not provide a fully working ServiceLoader.
If the factory isn't detected automatically, it's possible to add it through this method.

Parameters:

ravenFactory - ravenFactory to support.

ravenInstance

public static Raven ravenInstance()

Creates an instance of Raven using the DSN obtain through Dsn.dsnLookup().

Returns:

an instance of Raven.

ravenInstance

public static Raven ravenInstance(String dsn)

Creates an instance of Raven using the provided DSN.

Parameters:

dsn - Data Source Name of the Sentry server.

Returns:

an instance of Raven.

ravenInstance

public static Raven ravenInstance(Dsn dsn)

Creates an instance of Raven using the provided DSN.

Parameters:

dsn - Data Source Name of the Sentry server.

Returns:

an instance of Raven.

ravenInstance

public static Raven ravenInstance(Dsn dsn,
                  String ravenFactoryName)

Creates an instance of Raven using the provided DSN and the specified factory.

Parameters:

dsn - Data Source Name of the Sentry server.

ravenFactoryName - name of the raven factory to use to generate an instance of Raven.

Returns:

an instance of Raven.

Throws:

IllegalStateException - when no instance of Raven has been created.

createRavenInstance

public abstract Raven createRavenInstance(Dsn dsn)

Creates an instance of Raven given a DSN.

Parameters:

dsn - Data Source Name of the Sentry server.

Returns:

an instance of Raven.

Throws:

RuntimeException - when an instance couldn't be created.