Module spring.data.cassandra

Package org.springframework.data.cassandra.core.cql.keyspace

Class CreateUserTypeSpecification

java.lang.Object

org.springframework.data.cassandra.core.cql.keyspace.UserTypeNameSpecification

org.springframework.data.cassandra.core.cql.keyspace.UserTypeSpecification<CreateUserTypeSpecification>

org.springframework.data.cassandra.core.cql.keyspace.CreateUserTypeSpecification

All Implemented Interfaces:

CqlSpecification

public class CreateUserTypeSpecification
extends UserTypeSpecification<CreateUserTypeSpecification>
implements CqlSpecification

Object to configure a CREATE TYPE specification.

Since:

1.5

Author:

Fabio J. Mendes, Mark Paluch

See Also:

• CqlIdentifier

Method Summary

Modifier and Type	Method	Description
static CreateUserTypeSpecification	createType(com.datastax.oss.driver.api.core.CqlIdentifier typeName)	Entry point into the CreateUserTypeSpecification's fluent API given typeName to create a type.
static CreateUserTypeSpecification	createType(com.datastax.oss.driver.api.core.CqlIdentifier keyspace, com.datastax.oss.driver.api.core.CqlIdentifier typeName)	Entry point into the CreateUserTypeSpecification's fluent API given typeName to create a type.
static CreateUserTypeSpecification	createType(String typeName)	Entry point into the CreateUserTypeSpecification's fluent API given typeName to create a type.
boolean	getIfNotExists()
CreateUserTypeSpecification	ifNotExists()	Enables the inclusion of anIF NOT EXISTS clause.
CreateUserTypeSpecification	ifNotExists(boolean ifNotExists)	Sets the inclusion of an IF NOT EXISTS clause.

Methods inherited from class org.springframework.data.cassandra.core.cql.keyspace.UserTypeSpecification

field, field, getFields

Methods inherited from class org.springframework.data.cassandra.core.cql.keyspace.UserTypeNameSpecification

getKeyspace, getName

Methods inherited from class java.lang.Object

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

Method Details

createType

public static CreateUserTypeSpecification createType(String typeName)

Entry point into the CreateUserTypeSpecification's fluent API given typeName to create a type. Convenient if imported statically.

Parameters:

typeName - must not null or empty.

Returns:

a new CreateUserTypeSpecification.

createType

public static CreateUserTypeSpecification createType(com.datastax.oss.driver.api.core.CqlIdentifier typeName)

Entry point into the CreateUserTypeSpecification's fluent API given typeName to create a type. Convenient if imported statically.

Parameters:

typeName - must not null.

Returns:

a new CreateUserTypeSpecification.

createType

public static CreateUserTypeSpecification createType(@Nullable
 com.datastax.oss.driver.api.core.CqlIdentifier keyspace,
 com.datastax.oss.driver.api.core.CqlIdentifier typeName)

Entry point into the CreateUserTypeSpecification's fluent API given typeName to create a type. Convenient if imported statically. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the UDT name is prefixed with keyspace.

Parameters:

keyspace - can be null.

typeName - must not null.

Returns:

a new CreateUserTypeSpecification.

Since:

4.4

ifNotExists

public CreateUserTypeSpecification ifNotExists()

Enables the inclusion of anIF NOT EXISTS clause.

Returns:

this CreateUserTypeSpecification.

ifNotExists

public CreateUserTypeSpecification ifNotExists(boolean ifNotExists)

Sets the inclusion of an IF NOT EXISTS clause.

Parameters:

ifNotExists - true to include an IF NOT EXISTS clause, false to omit the IF NOT EXISTS clause.

Returns:

this CreateUserTypeSpecification.

getIfNotExists

public boolean getIfNotExists()

Returns:

true if the IF NOT EXISTS clause is included.