Module com.github.nosan.embedded.cassandra

Package com.github.nosan.embedded.cassandra

Interface Cassandra

public interface Cassandra

A simple interface that allows Cassandra to be started and stopped.

Refer to the package overview for more information.

Since:

4.0.0

Author:

Dmytro Nosan

See Also:

CassandraBuilder

Method Summary

Modifier and Type	Method	Description
String	getName()	Gets the name of this Cassandra instance.
Settings	getSettings()	Retrieves the Settings of this Cassandra instance.
Version	getVersion()	Retrieves the Version of this Cassandra instance.
Path	getWorkingDirectory()	Retrieves the working directory of this Cassandra instance.
boolean	isRunning()	Checks whether this Cassandra instance is running.
void	start()	Starts Cassandra.
void	stop()	Stops Cassandra.

Method Detail

start

void start()
    throws CassandraException

Starts Cassandra. Calling this method on an already started Cassandra has no effect. Causes the current thread to wait until Cassandra has started.

Throws:

CassandraException - if Cassandra cannot be started

stop

void stop()
   throws CassandraException

Stops Cassandra. Calling this method on an already stopped Cassandra has no effect. Causes the current thread to wait until Cassandra has stopped.

Throws:

CassandraException - if Cassandra cannot be stopped

isRunning

boolean isRunning()

Checks whether this Cassandra instance is running.

Returns:

true if Cassandra is running, otherwise false

getName

String getName()

Gets the name of this Cassandra instance.

Returns:

the name of the instance, never null

getVersion

Version getVersion()

Retrieves the Version of this Cassandra instance.

Returns:

the version of the instance, never null

getWorkingDirectory

Path getWorkingDirectory()

Retrieves the working directory of this Cassandra instance.

Returns:

the working directory, never null

getSettings

Settings getSettings()
              throws IllegalStateException

Retrieves the Settings of this Cassandra instance. The settings can only be obtained if Cassandra was successfully started. Causes the current thread to wait until Cassandra has either started or stopped.

Returns:

the settings of the instance

Throws:

IllegalStateException - if Cassandra was not started