org.jnosql.diana.cassandra.column.UDT Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cassandra-driver Show documentation

The Eclipse JNoSQL communication layer, Diana, to Cassandra

There is a newer version: 0.0.9

/*
 *  Copyright (c) 2017 Otávio Santana and others
 *   All rights reserved. This program and the accompanying materials
 *   are made available under the terms of the Eclipse Public License v1.0
 *   and Apache License v2.0 which accompanies this distribution.
 *   The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 *   and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
 *
 *   You may elect to redistribute this code under either of these licenses.
 *
 *   Contributors:
 *
 *   Otavio Santana
 */
package org.jnosql.diana.cassandra.column;


import org.jnosql.diana.api.column.Column;

/**
 * A Cassandra user data type, this interface does not support both Value alias method:
 * get(class) and get(TypeSupplier);
 */
public interface UDT extends Column {

    /**
     * The UDT name
     *
     * @return the UDT name
     */
    String getUserType();

    /**
     * Returns a UDT builder
     *
     * @param userType the user type name
     * @return the {@link UDTBuilder} instance
     * @throws NullPointerException when userType is null
     */
    static UDTNameBuilder builder(String userType) throws NullPointerException {
        return new UDTBuilder(userType);
    }
}