Package com.github.nosan.embedded.cassandra

Interface Cassandra

public interface Cassandra

Simple interface that allows the Cassandra to be started and stopped.

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()	Gets the Settings of this Cassandra instance.
Version	getVersion()	Gets the Version of this Cassandra instance.
Path	getWorkingDirectory()	Gets the working directory.
boolean	isRunning()	Checks whether this Cassandra is running.
void	start()	Starts the Cassandra.
void	stop()	Stops the Cassandra.

Method Detail

start

void start()
    throws CassandraException

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

Throws:

CassandraException - if the Cassandra cannot be started

stop

void stop()
   throws CassandraException

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

Throws:

CassandraException - if the Cassandra cannot be stopped

isRunning

boolean isRunning()

Checks whether this Cassandra is running.

Returns:

true if the Cassandra is running

getName

String getName()

Gets the name of this Cassandra instance.

Returns:

a name, never null

getVersion

Version getVersion()

Gets the Version of this Cassandra instance.

Returns:

a version, never null

getWorkingDirectory

Path getWorkingDirectory()

Gets the working directory.

Returns:

working directory, never null

getSettings

Settings getSettings()
              throws IllegalStateException

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

Returns:

the settings

Throws:

IllegalStateException - if Cassandra was not started